From ddb63f607a4eddc07a4ff24ec97fa8ab8b1d2989 Mon Sep 17 00:00:00 2001 From: wing328 Date: Tue, 18 Feb 2020 13:53:33 +0000 Subject: [PATCH] Deploy website version based on f9a040d1a7268f088bd738d48b93dd2ae9a316c2 --- 03abeb31.439ab358.js => 03abeb31.5504ac71.js | 2 +- 0cae4475.10314f9f.js => 0cae4475.fbe10da8.js | 2 +- 10211c0a.b01c1cd2.js => 10211c0a.fe71bb66.js | 2 +- 1777f326.1e08c66c.js | 1 + 1777f326.a1a28274.js | 1 - 1be78505.ab637336.js => 1be78505.662bfff6.js | 2 +- 342fbc7e.e90683ae.js => 342fbc7e.e9647373.js | 2 +- 404.html | 6 +++--- 7eeb204a.8b156741.js => 7eeb204a.bb152e0d.js | 2 +- 838bab07.2e0ec932.js => 838bab07.289b32ee.js | 2 +- 9972b359.9975d8a2.js => 9972b359.711ae1bd.js | 2 +- 9b517c7f.db10a211.js => 9b517c7f.cd53dca1.js | 2 +- 9cbcc25e.a995a4d1.js => 9cbcc25e.4026376b.js | 2 +- a6aa9e1f.db9abeea.js => a6aa9e1f.7b76081f.js | 2 +- ac8b7f2e.614520c4.js => ac8b7f2e.5e388b27.js | 2 +- blog/2018/12/24/new-website/index.html | 8 ++++---- blog/index.html | 8 ++++---- c4f5d8e4.e07a2691.js => c4f5d8e4.3a897df1.js | 2 +- ccc49370.2bf40702.js => ccc49370.76505ab1.js | 2 +- d9b8b8b3.80b16e54.js => d9b8b8b3.15ee97bd.js | 2 +- docs/code-of-conduct/index.html | 12 ++++++------ docs/contribute-building/index.html | 12 ++++++------ docs/contributing/index.html | 12 ++++++------ docs/core-team/index.html | 12 ++++++------ docs/customization/index.html | 10 +++++----- docs/debugging/index.html | 12 ++++++------ docs/faq-contributing/index.html | 10 +++++----- docs/faq-extending/index.html | 10 +++++----- docs/faq-generators/index.html | 10 +++++----- docs/faq/index.html | 10 +++++----- docs/fork-qna/index.html | 10 +++++----- docs/generators/README/index.html | 12 ++++++------ docs/generators/ada-server/index.html | 10 +++++----- docs/generators/ada/index.html | 10 +++++----- docs/generators/android/index.html | 10 +++++----- docs/generators/apache2/index.html | 10 +++++----- docs/generators/apex/index.html | 10 +++++----- docs/generators/asciidoc/index.html | 10 +++++----- docs/generators/aspnetcore/index.html | 10 +++++----- docs/generators/avro-schema/index.html | 10 +++++----- docs/generators/bash/index.html | 10 +++++----- docs/generators/c/index.html | 10 +++++----- docs/generators/clojure/index.html | 10 +++++----- docs/generators/cpp-pistache-server/index.html | 10 +++++----- docs/generators/cpp-qt5-client/index.html | 10 +++++----- .../generators/cpp-qt5-qhttpengine-server/index.html | 10 +++++----- docs/generators/cpp-restbed-server/index.html | 10 +++++----- docs/generators/cpp-restsdk/index.html | 10 +++++----- docs/generators/cpp-tizen/index.html | 10 +++++----- docs/generators/csharp-dotnet2/index.html | 10 +++++----- docs/generators/csharp-nancyfx/index.html | 10 +++++----- docs/generators/csharp-netcore/index.html | 10 +++++----- docs/generators/csharp/index.html | 10 +++++----- docs/generators/cwiki/index.html | 10 +++++----- docs/generators/dart-dio/index.html | 10 +++++----- docs/generators/dart-jaguar/index.html | 10 +++++----- docs/generators/dart/index.html | 10 +++++----- docs/generators/dynamic-html/index.html | 10 +++++----- docs/generators/eiffel/index.html | 10 +++++----- docs/generators/elixir/index.html | 10 +++++----- docs/generators/elm/index.html | 10 +++++----- docs/generators/erlang-client/index.html | 10 +++++----- docs/generators/erlang-proper/index.html | 10 +++++----- docs/generators/erlang-server/index.html | 10 +++++----- docs/generators/flash/index.html | 10 +++++----- docs/generators/fsharp-functions/index.html | 10 +++++----- docs/generators/fsharp-giraffe-server/index.html | 10 +++++----- docs/generators/go-experimental/index.html | 10 +++++----- docs/generators/go-gin-server/index.html | 10 +++++----- docs/generators/go-server/index.html | 10 +++++----- docs/generators/go/index.html | 10 +++++----- .../graphql-nodejs-express-server/index.html | 10 +++++----- docs/generators/graphql-schema/index.html | 10 +++++----- docs/generators/groovy/index.html | 10 +++++----- docs/generators/haskell-http-client/index.html | 10 +++++----- docs/generators/haskell/index.html | 10 +++++----- docs/generators/html/index.html | 10 +++++----- docs/generators/html2/index.html | 10 +++++----- docs/generators/index.html | 12 ++++++------ docs/generators/java-inflector/index.html | 10 +++++----- docs/generators/java-msf4j/index.html | 10 +++++----- docs/generators/java-pkmst/index.html | 10 +++++----- docs/generators/java-play-framework/index.html | 10 +++++----- docs/generators/java-undertow-server/index.html | 10 +++++----- docs/generators/java-vertx-web/index.html | 10 +++++----- docs/generators/java-vertx/index.html | 10 +++++----- docs/generators/java/index.html | 10 +++++----- .../generators/javascript-closure-angular/index.html | 10 +++++----- docs/generators/javascript-flowtyped/index.html | 10 +++++----- docs/generators/javascript/index.html | 10 +++++----- docs/generators/jaxrs-cxf-cdi/index.html | 10 +++++----- docs/generators/jaxrs-cxf-client/index.html | 10 +++++----- docs/generators/jaxrs-cxf-extended/index.html | 10 +++++----- docs/generators/jaxrs-cxf/index.html | 10 +++++----- docs/generators/jaxrs-jersey/index.html | 10 +++++----- docs/generators/jaxrs-resteasy-eap/index.html | 10 +++++----- docs/generators/jaxrs-resteasy/index.html | 10 +++++----- docs/generators/jaxrs-spec/index.html | 10 +++++----- docs/generators/jmeter/index.html | 10 +++++----- docs/generators/kotlin-server/index.html | 10 +++++----- docs/generators/kotlin-spring/index.html | 10 +++++----- docs/generators/kotlin-vertx/index.html | 10 +++++----- docs/generators/kotlin/index.html | 10 +++++----- docs/generators/lua/index.html | 10 +++++----- docs/generators/markdown/index.html | 10 +++++----- docs/generators/mysql-schema/index.html | 10 +++++----- docs/generators/nim/index.html | 10 +++++----- docs/generators/nodejs-express-server/index.html | 10 +++++----- docs/generators/nodejs-server-deprecated/index.html | 10 +++++----- docs/generators/objc/index.html | 10 +++++----- docs/generators/ocaml/index.html | 10 +++++----- docs/generators/openapi-yaml/index.html | 10 +++++----- docs/generators/openapi/index.html | 10 +++++----- docs/generators/perl/index.html | 10 +++++----- docs/generators/php-laravel/index.html | 10 +++++----- docs/generators/php-lumen/index.html | 10 +++++----- docs/generators/php-silex/index.html | 10 +++++----- docs/generators/php-slim-deprecated/index.html | 10 +++++----- docs/generators/php-slim4/index.html | 10 +++++----- docs/generators/php-symfony/index.html | 10 +++++----- docs/generators/php-ze-ph/index.html | 10 +++++----- docs/generators/php/index.html | 10 +++++----- docs/generators/powershell/index.html | 10 +++++----- docs/generators/protobuf-schema/index.html | 10 +++++----- docs/generators/python-aiohttp/index.html | 10 +++++----- docs/generators/python-blueplanet/index.html | 10 +++++----- docs/generators/python-experimental/index.html | 10 +++++----- docs/generators/python-flask/index.html | 10 +++++----- docs/generators/python/index.html | 10 +++++----- docs/generators/r/index.html | 10 +++++----- docs/generators/ruby-on-rails/index.html | 10 +++++----- docs/generators/ruby-sinatra/index.html | 10 +++++----- docs/generators/ruby/index.html | 10 +++++----- docs/generators/rust-server/index.html | 10 +++++----- docs/generators/rust/index.html | 10 +++++----- docs/generators/scala-akka/index.html | 10 +++++----- docs/generators/scala-finch/index.html | 10 +++++----- docs/generators/scala-gatling/index.html | 10 +++++----- .../scala-httpclient-deprecated/index.html | 10 +++++----- docs/generators/scala-lagom-server/index.html | 10 +++++----- docs/generators/scala-play-server/index.html | 10 +++++----- docs/generators/scalatra/index.html | 10 +++++----- docs/generators/scalaz/index.html | 10 +++++----- docs/generators/spring/index.html | 10 +++++----- docs/generators/swift2-deprecated/index.html | 10 +++++----- docs/generators/swift3-deprecated/index.html | 10 +++++----- docs/generators/swift4/index.html | 10 +++++----- docs/generators/swift5/index.html | 10 +++++----- docs/generators/typescript-angular/index.html | 10 +++++----- docs/generators/typescript-angularjs/index.html | 10 +++++----- docs/generators/typescript-aurelia/index.html | 10 +++++----- docs/generators/typescript-axios/index.html | 10 +++++----- docs/generators/typescript-fetch/index.html | 10 +++++----- docs/generators/typescript-inversify/index.html | 10 +++++----- docs/generators/typescript-jquery/index.html | 10 +++++----- docs/generators/typescript-node/index.html | 10 +++++----- docs/generators/typescript-redux-query/index.html | 10 +++++----- docs/generators/typescript-rxjs/index.html | 10 +++++----- docs/installation/index.html | 10 +++++----- docs/integrations/index.html | 12 ++++++------ docs/new-generator/index.html | 12 ++++++------ docs/online/index.html | 12 ++++++------ docs/plugins/index.html | 12 ++++++------ docs/release-3-0-0/index.html | 10 +++++----- docs/release-summary/index.html | 12 ++++++------ docs/roadmap/index.html | 12 ++++++------ docs/spec-info/index.html | 12 ++++++------ docs/swagger-codegen-migration/index.html | 12 ++++++------ docs/templating/index.html | 10 +++++----- docs/usage/index.html | 10 +++++----- e360e27f.f40b8b31.js => e360e27f.30da012c.js | 2 +- ecfe08ed.331938a0.js => ecfe08ed.dfca7605.js | 2 +- f70cb32f.6319ce67.js => f70cb32f.8c372e24.js | 2 +- index.html | 8 ++++---- main.429a9e72.js => main.25b2c56a.js | 4 ++-- ...72.js.LICENSE.txt => main.25b2c56a.js.LICENSE.txt | 0 runtime~main.f4b46d2f.js => runtime~main.0b3dba48.js | 2 +- styles.62ba095c.css => styles.ec5417b5.css | 0 team/index.html | 6 +++--- users.html | 6 +++--- users/index.html | 6 +++--- 181 files changed, 811 insertions(+), 811 deletions(-) rename 03abeb31.439ab358.js => 03abeb31.5504ac71.js (99%) rename 0cae4475.10314f9f.js => 0cae4475.fbe10da8.js (98%) rename 10211c0a.b01c1cd2.js => 10211c0a.fe71bb66.js (99%) create mode 100644 1777f326.1e08c66c.js delete mode 100644 1777f326.a1a28274.js rename 1be78505.ab637336.js => 1be78505.662bfff6.js (99%) rename 342fbc7e.e90683ae.js => 342fbc7e.e9647373.js (98%) rename 7eeb204a.8b156741.js => 7eeb204a.bb152e0d.js (99%) rename 838bab07.2e0ec932.js => 838bab07.289b32ee.js (86%) rename 9972b359.9975d8a2.js => 9972b359.711ae1bd.js (99%) rename 9b517c7f.db10a211.js => 9b517c7f.cd53dca1.js (99%) rename 9cbcc25e.a995a4d1.js => 9cbcc25e.4026376b.js (90%) rename a6aa9e1f.db9abeea.js => a6aa9e1f.7b76081f.js (98%) rename ac8b7f2e.614520c4.js => ac8b7f2e.5e388b27.js (96%) rename c4f5d8e4.e07a2691.js => c4f5d8e4.3a897df1.js (99%) rename ccc49370.2bf40702.js => ccc49370.76505ab1.js (99%) rename d9b8b8b3.80b16e54.js => d9b8b8b3.15ee97bd.js (87%) rename e360e27f.f40b8b31.js => e360e27f.30da012c.js (98%) rename ecfe08ed.331938a0.js => ecfe08ed.dfca7605.js (99%) rename f70cb32f.6319ce67.js => f70cb32f.8c372e24.js (98%) rename main.429a9e72.js => main.25b2c56a.js (99%) rename main.429a9e72.js.LICENSE.txt => main.25b2c56a.js.LICENSE.txt (100%) rename runtime~main.f4b46d2f.js => runtime~main.0b3dba48.js (71%) rename styles.62ba095c.css => styles.ec5417b5.css (100%) diff --git a/03abeb31.439ab358.js b/03abeb31.5504ac71.js similarity index 99% rename from 03abeb31.439ab358.js rename to 03abeb31.5504ac71.js index 3793d30e3e4..41636fbb31e 100644 --- a/03abeb31.439ab358.js +++ b/03abeb31.5504ac71.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[5],{132:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return i})),n.d(t,"metadata",(function(){return l})),n.d(t,"rightToc",(function(){return c})),n.d(t,"default",(function(){return p}));var r=n(1),o=n(9),a=(n(0),n(296)),i={id:"debugging",title:"Debugging"},l={id:"debugging",title:"Debugging",description:"## Templates",source:"@site/../docs/debugging.md",permalink:"/docs/debugging",editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/debugging.md",lastUpdatedBy:"William Cheng",lastUpdatedAt:1581087531,sidebar:"docs",previous:{title:"Customization",permalink:"/docs/customization"},next:{title:"Workflow Integrations",permalink:"/docs/integrations"}},c=[{value:"Templates",id:"templates",children:[]},{value:"Runtime",id:"runtime",children:[]},{value:"Logs",id:"logs",children:[]}],b={rightToc:c};function p(e){var t=e.components,n=Object(o.a)(e,["components"]);return Object(a.b)("wrapper",Object(r.a)({},b,n,{components:t,mdxType:"MDXLayout"}),Object(a.b)("h2",{id:"templates"},"Templates"),Object(a.b)("p",null,"Sometimes, you may have issues with variables in your templates. As discussed in the ",Object(a.b)("a",Object(r.a)({parentName:"p"},{href:"/docs/templating"}),"templating")," docs, we offer a variety of system properties for inspecting the models bound to templates."),Object(a.b)("dl",null,Object(a.b)("dt",null,Object(a.b)("code",null,"-DdebugOpenAPI")),Object(a.b)("dd",null,"Prints out the JSON model of the OpenAPI Document, as seen by OpenAPI Generator"),Object(a.b)("dt",null,Object(a.b)("code",null,"-DdebugModels")),Object(a.b)("dd",null,"Prints out the JSON model passed to model templates"),Object(a.b)("dt",null,Object(a.b)("code",null,"-DdebugOperations")),Object(a.b)("dd",null,"Prints out the JSON model passed to operation (api) templates"),Object(a.b)("dt",null,Object(a.b)("code",null,"-DdebugSupportingFiles")),Object(a.b)("dd",null,"Prints out the JSON model passed to supporting files")),Object(a.b)("p",null,"One or more of these properties can be passed alongside other command line options:"),Object(a.b)("pre",null,Object(a.b)("code",Object(r.a)({parentName:"pre"},{className:"language-bash"}),"openapi-generator generate -g go \\\n -o out \\\n -i petstore-minimal.yaml \\\n -DdebugModels \\\n -DdebugOperations\n")),Object(a.b)("p",null,"Or you can add these to your ",Object(a.b)("inlineCode",{parentName:"p"},"JAVA_OPTS")," environment variable (this applies to every invocation of the tool):"),Object(a.b)("pre",null,Object(a.b)("code",Object(r.a)({parentName:"pre"},{className:"language-bash"}),'export JAVA_OPTS="${JAVA_OPTS} -DdebugModels -DdebugOperations"\n')),Object(a.b)("blockquote",null,Object(a.b)("p",{parentName:"blockquote"},"NOTE: Globally available system options like these will apply to all invocations of the generator (CLI and plugins)")),Object(a.b)("h2",{id:"runtime"},"Runtime"),Object(a.b)("p",null,"When you're working with a custom generator, a new generator, or otherwise trying to understand the behavior of the toolset, you may need to attach a remote debugger in order to step through the code."),Object(a.b)("p",null,"The steps are shown here for a specific version of the generator, but apply the same if you're working off master or a feature branch."),Object(a.b)("ul",null,Object(a.b)("li",{parentName:"ul"},"Determine the version of ",Object(a.b)("inlineCode",{parentName:"li"},"openapi-generator")," you're using. For the CLI, this is: ",Object(a.b)("pre",{parentName:"li"},Object(a.b)("code",Object(r.a)({parentName:"pre"},{}),"openapi-generator version\n"))),Object(a.b)("li",{parentName:"ul"},"Navigate to the ",Object(a.b)("inlineCode",{parentName:"li"},"openapi-generator")," source directory (see ",Object(a.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/contribute-building"}),"building")," docs for obtaining source code and brief introduction)."),Object(a.b)("li",{parentName:"ul"},"Checkout the branch/tag for the target version. Branches are not prefixed, but tags are prefixed with a ",Object(a.b)("inlineCode",{parentName:"li"},"v"),". For instance if you're using version ",Object(a.b)("inlineCode",{parentName:"li"},"3.3.0"),", you will execute:",Object(a.b)("pre",{parentName:"li"},Object(a.b)("code",Object(r.a)({parentName:"pre"},{}),"git checkout v3.3.0\n"))),Object(a.b)("li",{parentName:"ul"},"Open the project in your IDE."),Object(a.b)("li",{parentName:"ul"},"Setup your IDE for remote debugging. You'll want to define a port used for connecting the remote debugger. For this example, we'll use ",Object(a.b)("inlineCode",{parentName:"li"},"5005"),". See external tutorials for ",Object(a.b)("a",Object(r.a)({parentName:"li"},{href:"https://www.jetbrains.com/help/idea/run-debug-configuration-remote-debug.html"}),"IntelliJ")," and ",Object(a.b)("a",Object(r.a)({parentName:"li"},{href:"https://www.ibm.com/developerworks/library/os-eclipse-javadebug/index.html"}),"Eclipse")),Object(a.b)("li",{parentName:"ul"},"Export the debug configuration, specifying ",Object(a.b)("inlineCode",{parentName:"li"},"suspend=y")," so you have time to attach a remote debugger. These are passed as Java system properties, either on command line or as part of the ",Object(a.b)("inlineCode",{parentName:"li"},"JAVA_OPTS")," environment variable. This will look like:",Object(a.b)("pre",{parentName:"li"},Object(a.b)("code",Object(r.a)({parentName:"pre"},{}),'export JAVA_OPTS="${JAVA_OPTS} -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"\n'))),Object(a.b)("li",{parentName:"ul"},"Execute the generator with your desired options. You should see the application output ",Object(a.b)("em",{parentName:"li"},"only"),Object(a.b)("pre",{parentName:"li"},Object(a.b)("code",Object(r.a)({parentName:"pre"},{}),"Listening for transport dt_socket at address: 5005\n"))),Object(a.b)("li",{parentName:"ul"},"Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.")),Object(a.b)("h2",{id:"logs"},"Logs"),Object(a.b)("p",null,"You can try to enable debugging log with ",Object(a.b)("inlineCode",{parentName:"p"},"-Dlog.level=debug")," option to the ",Object(a.b)("inlineCode",{parentName:"p"},"JAVA_OPTS")," environment variable to see more information:"),Object(a.b)("pre",null,Object(a.b)("code",Object(r.a)({parentName:"pre"},{className:"language-bash"}),'export JAVA_OPTS="${JAVA_OPTS} -Dlog.level=debug"\n')),Object(a.b)("p",null,"Set the option then DEBUG logs are printed out:"),Object(a.b)("pre",null,Object(a.b)("code",Object(r.a)({parentName:"pre"},{className:"language-bash"}),"openapi-generator generate -g go ...\n\n...\n...\n[main] DEBUG o.o.codegen.DefaultCodegen - debugging fromProperty for files : class Schema {\n type: null\n format: null\n $ref: #/components/schemas/File\n...\n...\n")))}p.isMDXComponent=!0},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return s})),n.d(t,"b",(function(){return m}));var r=n(0),o=n.n(r);function a(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var b=o.a.createContext({}),p=function(e){var t=o.a.useContext(b),n=t;return e&&(n="function"==typeof e?e(t):l({},t,{},e)),n},s=function(e){var t=p(e.components);return o.a.createElement(b.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},d=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,i=e.parentName,b=c(e,["components","mdxType","originalType","parentName"]),s=p(n),d=r,m=s["".concat(i,".").concat(d)]||s[d]||u[d]||a;return n?o.a.createElement(m,l({ref:t},b,{components:n})):o.a.createElement(m,l({ref:t},b))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,i=new Array(a);i[0]=d;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:r,i[1]=l;for(var b=2;b=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var b=o.a.createContext({}),p=function(e){var t=o.a.useContext(b),n=t;return e&&(n="function"==typeof e?e(t):l({},t,{},e)),n},s=function(e){var t=p(e.components);return o.a.createElement(b.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},d=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,a=e.originalType,i=e.parentName,b=c(e,["components","mdxType","originalType","parentName"]),s=p(n),d=r,m=s["".concat(i,".").concat(d)]||s[d]||u[d]||a;return n?o.a.createElement(m,l({ref:t},b,{components:n})):o.a.createElement(m,l({ref:t},b))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var a=n.length,i=new Array(a);i[0]=d;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:r,i[1]=l;for(var b=2;b=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=o.a.createContext({}),s=function(e){var t=o.a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},b=function(e){var t=s(e.components);return o.a.createElement(i.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},d=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),b=s(n),d=a,m=b["".concat(p,".").concat(d)]||b[d]||u[d]||r;return n?o.a.createElement(m,c({ref:t},i,{components:n})):o.a.createElement(m,c({ref:t},i))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=d;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:a,p[1]=c;for(var i=2;i=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var i=o.a.createContext({}),s=function(e){var t=o.a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},b=function(e){var t=s(e.components);return o.a.createElement(i.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},d=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,r=e.originalType,p=e.parentName,i=l(e,["components","mdxType","originalType","parentName"]),b=s(n),d=a,m=b["".concat(p,".").concat(d)]||b[d]||u[d]||r;return n?o.a.createElement(m,c({ref:t},i,{components:n})):o.a.createElement(m,c({ref:t},i))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var r=n.length,p=new Array(r);p[0]=d;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:a,p[1]=c;for(var i=2;i\n## Documentation for API Endpoints\n\nAll URIs are relative to *{{{basePath}}}*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}\n{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}\n{{/generateApiDocs}}\n\n{{#generateModelDocs}}\n\n## Documentation for Models\n\n{{#modelPackage}}\n{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)\n{{/model}}{{/models}}\n{{/modelPackage}}\n{{^modelPackage}}\nNo model defined in this package\n{{/modelPackage}}\n{{/generateModelDocs}}\n\n{{! TODO: optional documentation for authorization? }}\n## Documentation for Authorization\n\n{{^authMethods}}\nAll endpoints do not require authorization.\n{{/authMethods}}\n{{#authMethods}}\n{{#last}}\nAuthentication schemes defined for the API:\n{{/last}}\n{{/authMethods}}\n{{#authMethods}}\n\n### {{name}}\n\n{{#isApiKey}}- **Type**: API key\n- **API key parameter name**: {{keyParamName}}\n- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}\n{{/isApiKey}}\n{{#isBasic}}- **Type**: HTTP basic authentication\n{{/isBasic}}\n{{#isOAuth}}- **Type**: OAuth\n- **Flow**: {{flow}}\n- **Authorization URL**: {{authorizationUrl}}\n- **Scopes**: {{^scopes}}N/A{{/scopes}}\n{{#scopes}} - {{scope}}: {{description}}\n{{/scopes}}\n{{/isOAuth}}\n\n{{/authMethods}}\n')),Object(o.b)("p",null,"Let's not focus too much on the contents of this file. You may refer to ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"/docs/templating"}),"templating")," for more details on the variables bound to these files and to ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"/docs/debugging"}),"debugging"),' how to debug the structures. Of note here is that we\'re generating structures in markdown as defined by the objects constructed by our new "Config" class.'),Object(o.b)("h4",{id:"apimustache"},"api.mustache"),Object(o.b)("p",null,"The API documentation might look like this:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-mustache"}),'# {{classname}}{{#description}}\n{{description}}{{/description}}\n\nAll URIs are relative to *{{basePath}}*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}\n{{/operation}}{{/operations}}\n\n{{#operations}}\n{{#operation}}\n\n# **{{operationId}}**\n> {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})\n\n{{summary}}{{#notes}}\n\n{{notes}}{{/notes}}\n\n### Parameters\n{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}\n{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}\n{{/allParams}}\n\n### Return type\n\n{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}\n\n### Authorization\n\n{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}\n\n### HTTP request headers\n\n - **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}\n - **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}\n\n{{/operation}}\n{{/operations}}\n\n')),Object(o.b)("h4",{id:"modelmustache"},"model.mustache"),Object(o.b)("p",null,"The models file could resemble the following."),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-mustache"}),"{{#models}}\n{{#model}}\n# {{{packageName}}}.{{modelPackage}}.{{{classname}}}\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n{{#parent}}\n{{#parentVars}}\n**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}\n{{/parentVars}}\n{{/parent}}\n{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}\n{{/vars}}\n\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n{{/model}}\n{{/models}}\n")),Object(o.b)("h3",{id:"build-it"},"Build it"),Object(o.b)("p",null,"To compile quickly to test this out, you can run ",Object(o.b)("inlineCode",{parentName:"p"},"mvn clean package -DskipTests"),"."),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"When implementing a more robust generator, you'll want to run all tests as well: ",Object(o.b)("inlineCode",{parentName:"p"},"mvn clean package"))),Object(o.b)("h3",{id:"compile-sample"},"Compile Sample"),Object(o.b)("p",null,"The ",Object(o.b)("inlineCode",{parentName:"p"},"new.sh")," script created ",Object(o.b)("inlineCode",{parentName:"p"},"bin/common-mark-documentation-petstore.sh"),":"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),'#!/bin/sh\n\nSCRIPT="$0"\n\nwhile [ -h "$SCRIPT" ] ; do\n ls=$(ls -ld "$SCRIPT")\n link=$(expr "$ls" : \'.*-> \\(.*\\)$\')\n if expr "$link" : \'/.*\' > /dev/null; then\n SCRIPT="$link"\n else\n SCRIPT=$(dirname "$SCRIPT")/"$link"\n fi\ndone\n\nif [ ! -d "${APP_DIR}" ]; then\n APP_DIR=$(dirname "$SCRIPT")/..\n APP_DIR=$(cd "${APP_DIR}"; pwd)\nfi\n\nexecutable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"\n\nif [ ! -f "$executable" ]\nthen\n mvn clean package\nfi\n\n# if you\'ve executed sbt assembly previously it will use that instead.\nexport JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"\nags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/mark"\n\njava ${JAVA_OPTS} -jar ${executable} ${ags}\n')),Object(o.b)("p",null,"This script is often used to apply default options for generation. A common option in most of these script is to define the template directory as the generator's directory under ",Object(o.b)("inlineCode",{parentName:"p"},"resources"),". This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a ",Object(o.b)("inlineCode",{parentName:"p"},"CliOption"),")."),Object(o.b)("p",null,"Add ",Object(o.b)("inlineCode",{parentName:"p"},"-t modules/openapi-generator/src/main/resources/common-mark-documentation")," to ",Object(o.b)("inlineCode",{parentName:"p"},"ags")," line to simplify the evaluation of template-only modifications:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-diff"}),'diff --git a/bin/markdown-documentation-petstore.sh b/bin/markdown-documentation-petstore.sh\nindex d816771478..94b4ce6d12 100644\n--- a/bin/markdown-documentation-petstore.sh\n+++ b/bin/markdown-documentation-petstore.sh\n@@ -26,6 +26,6 @@ fi\n\n # if you\'ve executed sbt assembly previously it will use that instead.\n export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"\n-ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common-mark"\n+ags="$@ generate -t modules/openapi-generator/src/main/resources/common-mark-documentation -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/markdown"\n\n java ${JAVA_OPTS} -jar ${executable} ${ags}\n')),Object(o.b)("h3",{id:"verify-output"},"Verify output"),Object(o.b)("p",null,"Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works."),Object(o.b)("p",null,"For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install ",Object(o.b)("inlineCode",{parentName:"p"},"markserv"),":"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),"npm install --global markserv\n")),Object(o.b)("p",null,"Now, you can serve the output directory directly and test your links:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),"markserv samples/documentation/petstore/common/markdown\n")),Object(o.b)("p",null,"That's it! You've created your first generator!"))}c.isMDXComponent=!0},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return m})),n.d(t,"b",(function(){return b}));var a=n(0),r=n.n(a);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=r.a.createContext({}),c=function(e){var t=r.a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s({},t,{},e)),n},m=function(e){var t=c(e.components);return r.a.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},u=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=c(n),u=a,b=m["".concat(i,".").concat(u)]||m[u]||d[u]||o;return n?r.a.createElement(b,s({ref:t},p,{components:n})):r.a.createElement(b,s({ref:t},p))}));function b(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var p=2;p\n## Documentation for API Endpoints\n\nAll URIs are relative to *{{{basePath}}}*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}\n{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}\n{{/generateApiDocs}}\n\n{{#generateModelDocs}}\n\n## Documentation for Models\n\n{{#modelPackage}}\n{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)\n{{/model}}{{/models}}\n{{/modelPackage}}\n{{^modelPackage}}\nNo model defined in this package\n{{/modelPackage}}\n{{/generateModelDocs}}\n\n{{! TODO: optional documentation for authorization? }}\n## Documentation for Authorization\n\n{{^authMethods}}\nAll endpoints do not require authorization.\n{{/authMethods}}\n{{#authMethods}}\n{{#last}}\nAuthentication schemes defined for the API:\n{{/last}}\n{{/authMethods}}\n{{#authMethods}}\n\n### {{name}}\n\n{{#isApiKey}}- **Type**: API key\n- **API key parameter name**: {{keyParamName}}\n- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}\n{{/isApiKey}}\n{{#isBasic}}- **Type**: HTTP basic authentication\n{{/isBasic}}\n{{#isOAuth}}- **Type**: OAuth\n- **Flow**: {{flow}}\n- **Authorization URL**: {{authorizationUrl}}\n- **Scopes**: {{^scopes}}N/A{{/scopes}}\n{{#scopes}} - {{scope}}: {{description}}\n{{/scopes}}\n{{/isOAuth}}\n\n{{/authMethods}}\n')),Object(o.b)("p",null,"Let's not focus too much on the contents of this file. You may refer to ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"/docs/templating"}),"templating")," for more details on the variables bound to these files and to ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"/docs/debugging"}),"debugging"),' how to debug the structures. Of note here is that we\'re generating structures in markdown as defined by the objects constructed by our new "Config" class.'),Object(o.b)("h4",{id:"apimustache"},"api.mustache"),Object(o.b)("p",null,"The API documentation might look like this:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-mustache"}),'# {{classname}}{{#description}}\n{{description}}{{/description}}\n\nAll URIs are relative to *{{basePath}}*\n\nMethod | HTTP request | Description\n------------- | ------------- | -------------\n{{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}\n{{/operation}}{{/operations}}\n\n{{#operations}}\n{{#operation}}\n\n# **{{operationId}}**\n> {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})\n\n{{summary}}{{#notes}}\n\n{{notes}}{{/notes}}\n\n### Parameters\n{{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}\nName | Type | Description | Notes\n------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}\n{{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}\n{{/allParams}}\n\n### Return type\n\n{{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}\n\n### Authorization\n\n{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}\n\n### HTTP request headers\n\n - **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}\n - **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}\n\n{{/operation}}\n{{/operations}}\n\n')),Object(o.b)("h4",{id:"modelmustache"},"model.mustache"),Object(o.b)("p",null,"The models file could resemble the following."),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-mustache"}),"{{#models}}\n{{#model}}\n# {{{packageName}}}.{{modelPackage}}.{{{classname}}}\n## Properties\n\nName | Type | Description | Notes\n------------ | ------------- | ------------- | -------------\n{{#parent}}\n{{#parentVars}}\n**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}\n{{/parentVars}}\n{{/parent}}\n{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}\n{{/vars}}\n\n[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)\n\n{{/model}}\n{{/models}}\n")),Object(o.b)("h3",{id:"build-it"},"Build it"),Object(o.b)("p",null,"To compile quickly to test this out, you can run ",Object(o.b)("inlineCode",{parentName:"p"},"mvn clean package -DskipTests"),"."),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"When implementing a more robust generator, you'll want to run all tests as well: ",Object(o.b)("inlineCode",{parentName:"p"},"mvn clean package"))),Object(o.b)("h3",{id:"compile-sample"},"Compile Sample"),Object(o.b)("p",null,"The ",Object(o.b)("inlineCode",{parentName:"p"},"new.sh")," script created ",Object(o.b)("inlineCode",{parentName:"p"},"bin/common-mark-documentation-petstore.sh"),":"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),'#!/bin/sh\n\nSCRIPT="$0"\n\nwhile [ -h "$SCRIPT" ] ; do\n ls=$(ls -ld "$SCRIPT")\n link=$(expr "$ls" : \'.*-> \\(.*\\)$\')\n if expr "$link" : \'/.*\' > /dev/null; then\n SCRIPT="$link"\n else\n SCRIPT=$(dirname "$SCRIPT")/"$link"\n fi\ndone\n\nif [ ! -d "${APP_DIR}" ]; then\n APP_DIR=$(dirname "$SCRIPT")/..\n APP_DIR=$(cd "${APP_DIR}"; pwd)\nfi\n\nexecutable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"\n\nif [ ! -f "$executable" ]\nthen\n mvn clean package\nfi\n\n# if you\'ve executed sbt assembly previously it will use that instead.\nexport JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"\nags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/mark"\n\njava ${JAVA_OPTS} -jar ${executable} ${ags}\n')),Object(o.b)("p",null,"This script is often used to apply default options for generation. A common option in most of these script is to define the template directory as the generator's directory under ",Object(o.b)("inlineCode",{parentName:"p"},"resources"),". This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a ",Object(o.b)("inlineCode",{parentName:"p"},"CliOption"),")."),Object(o.b)("p",null,"Add ",Object(o.b)("inlineCode",{parentName:"p"},"-t modules/openapi-generator/src/main/resources/common-mark-documentation")," to ",Object(o.b)("inlineCode",{parentName:"p"},"ags")," line to simplify the evaluation of template-only modifications:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-diff"}),'diff --git a/bin/markdown-documentation-petstore.sh b/bin/markdown-documentation-petstore.sh\nindex d816771478..94b4ce6d12 100644\n--- a/bin/markdown-documentation-petstore.sh\n+++ b/bin/markdown-documentation-petstore.sh\n@@ -26,6 +26,6 @@ fi\n\n # if you\'ve executed sbt assembly previously it will use that instead.\n export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"\n-ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common-mark"\n+ags="$@ generate -t modules/openapi-generator/src/main/resources/common-mark-documentation -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/markdown"\n\n java ${JAVA_OPTS} -jar ${executable} ${ags}\n')),Object(o.b)("h3",{id:"verify-output"},"Verify output"),Object(o.b)("p",null,"Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works."),Object(o.b)("p",null,"For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install ",Object(o.b)("inlineCode",{parentName:"p"},"markserv"),":"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),"npm install --global markserv\n")),Object(o.b)("p",null,"Now, you can serve the output directory directly and test your links:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),"markserv samples/documentation/petstore/common/markdown\n")),Object(o.b)("p",null,"That's it! You've created your first generator!"))}c.isMDXComponent=!0},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return m})),n.d(t,"b",(function(){return b}));var a=n(0),r=n.n(a);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function s(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var p=r.a.createContext({}),c=function(e){var t=r.a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):s({},t,{},e)),n},m=function(e){var t=c(e.components);return r.a.createElement(p.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},u=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,i=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),m=c(n),u=a,b=m["".concat(i,".").concat(u)]||m[u]||d[u]||o;return n?r.a.createElement(b,s({ref:t},p,{components:n})):r.a.createElement(b,s({ref:t},p))}));function b(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,i=new Array(o);i[0]=u;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,i[1]=s;for(var p=2;p use Swagger core v3 (see ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/OpenAPITools/openapi-generator/issues/27%5B#27%5D"}),"https://github.com/OpenAPITools/openapi-generator/issues/27[#27]"),")"))),Object(o.b)("li",{parentName:"ul"},"Documentation"),Object(o.b)("li",{parentName:"ul"},"Static pages, preferably on gh-pages, devoted to each generator"),Object(o.b)("li",{parentName:"ul"},"Explain generator options"),Object(o.b)("li",{parentName:"ul"},"Centralized docs on generated code usage/examples/configuration")),Object(o.b)("h2",{id:"medium-term"},"Medium-term"),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"Feature set, well-defined API (code and templates), and extensibility improvements.")),Object(o.b)("h3",{id:"api"},"API"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"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."),Object(o.b)("li",{parentName:"ul"},"Feature set (potential generators to add; not an exhaustive list)",Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},"Azure functions (node.js, server)"),Object(o.b)("li",{parentName:"ul"},"Finagle HTTP Client (Scala, client)"),Object(o.b)("li",{parentName:"ul"},"Finagle Http Server (Scala, server)"),Object(o.b)("li",{parentName:"ul"},"Finatra (Scala, server)"),Object(o.b)("li",{parentName:"ul"},"Kotlin Spring MVC/Springboot (server)"),Object(o.b)("li",{parentName:"ul"},"C++ Server, any framework (server)")))),Object(o.b)("h3",{id:"general"},"General"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Migrate from Maven to Gradle"),Object(o.b)("li",{parentName:"ul"},"Java 9+ support"),Object(o.b)("li",{parentName:"ul"},"Feature set (other options to investigate)"),Object(o.b)("li",{parentName:"ul"},"SPI plugins",Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},"Templating engine"),Object(o.b)("li",{parentName:"ul"},"Language extensions"),Object(o.b)("li",{parentName:"ul"},"Custom extensions (e.g. allowing users to load support for ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/Azure/azure-rest-api-specs%5Bazure-rest-api-specs%5D"}),"https://github.com/Azure/azure-rest-api-specs[azure-rest-api-specs]"),")"))),Object(o.b)("li",{parentName:"ul"},"Customizable templating engines (handlebars support)"),Object(o.b)("li",{parentName:"ul"},"Unit-testing templates (to previously mentioned explicit type as an interface to the template)"),Object(o.b)("li",{parentName:"ul"},"Reduce coupling"),Object(o.b)("li",{parentName:"ul"},"Make types extending ",Object(o.b)("inlineCode",{parentName:"li"},"CodegenConfig")," become the generation entrypoint"),Object(o.b)("li",{parentName:"ul"},"Allow current ",Object(o.b)("inlineCode",{parentName:"li"},"CodegenConfig")," types to define templating engine"),Object(o.b)("li",{parentName:"ul"},"Allow current ",Object(o.b)("inlineCode",{parentName:"li"},"CodegenConfig")," types to modify workflow (currently encapsulated in ",Object(o.b)("inlineCode",{parentName:"li"},"DefaultGenerator")," and tightly coupled to the template engine"),Object(o.b)("li",{parentName:"ul"},'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.'),Object(o.b)("li",{parentName:"ul"},"Define template deprecation/removal process")),Object(o.b)("h2",{id:"long-term"},"Long-term"),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"Expanding tooling offered, integrations, potentially SaaS offering to partially fund efforts.")),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Generator UI wrappers",Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},"Move jimschubert/intellij-swagger-codegen plugin under the org, and rename"),Object(o.b)("li",{parentName:"ul"},"Look into an Eclipse UI wrapper around the generator"),Object(o.b)("li",{parentName:"ul"},"Look at Visual Studio Code (and/or Atom, sublime text) integration"))),Object(o.b)("li",{parentName:"ul"},"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."),Object(o.b)("li",{parentName:"ul"},"A paid service (SaaS) for generation may be enticing for some users. Such a service would allow for statistics (mentioned earlier in telemetry)"),Object(o.b)("li",{parentName:"ul"},"Additional tools"),Object(o.b)("li",{parentName:"ul"},"node.js build system(s) integration (grunt/gulp/webpack/etc)"),Object(o.b)("li",{parentName:"ul"},"ruby gem"),Object(o.b)("li",{parentName:"ul"},"others (which may require previously mentioned SaaS API)")))}u.isMDXComponent=!0},296:function(e,t,r){"use strict";r.d(t,"a",(function(){return s})),r.d(t,"b",(function(){return d}));var n=r(0),a=r.n(n);function o(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=a.a.createContext({}),u=function(e){var t=a.a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l({},t,{},e)),r},s=function(e){var t=u(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},m=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,o=e.originalType,i=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),s=u(r),m=n,d=s["".concat(i,".").concat(m)]||s[m]||b[m]||o;return r?a.a.createElement(d,l({ref:t},p,{components:r})):a.a.createElement(d,l({ref:t},p))}));function d(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=r.length,i=new Array(o);i[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:n,i[1]=l;for(var p=2;p use Swagger core v3 (see ",Object(i.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/OpenAPITools/openapi-generator/issues/27%5B#27%5D"}),"https://github.com/OpenAPITools/openapi-generator/issues/27[#27]"),")"))),Object(i.b)("li",{parentName:"ul"},"Documentation"),Object(i.b)("li",{parentName:"ul"},"Static pages, preferably on gh-pages, devoted to each generator"),Object(i.b)("li",{parentName:"ul"},"Explain generator options"),Object(i.b)("li",{parentName:"ul"},"Centralized docs on generated code usage/examples/configuration")),Object(i.b)("h2",{id:"medium-term"},"Medium-term"),Object(i.b)("blockquote",null,Object(i.b)("p",{parentName:"blockquote"},"Feature set, well-defined API (code and templates), and extensibility improvements.")),Object(i.b)("h3",{id:"api"},"API"),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"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."),Object(i.b)("li",{parentName:"ul"},"Feature set (potential generators to add; not an exhaustive list)",Object(i.b)("ul",{parentName:"li"},Object(i.b)("li",{parentName:"ul"},"Azure functions (node.js, server)"),Object(i.b)("li",{parentName:"ul"},"Finagle HTTP Client (Scala, client)"),Object(i.b)("li",{parentName:"ul"},"Finagle Http Server (Scala, server)"),Object(i.b)("li",{parentName:"ul"},"Finatra (Scala, server)"),Object(i.b)("li",{parentName:"ul"},"Kotlin Spring MVC/Springboot (server)"),Object(i.b)("li",{parentName:"ul"},"C++ Server, any framework (server)")))),Object(i.b)("h3",{id:"general"},"General"),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"Migrate from Maven to Gradle"),Object(i.b)("li",{parentName:"ul"},"Java 9+ support"),Object(i.b)("li",{parentName:"ul"},"Feature set (other options to investigate)"),Object(i.b)("li",{parentName:"ul"},"SPI plugins",Object(i.b)("ul",{parentName:"li"},Object(i.b)("li",{parentName:"ul"},"Templating engine"),Object(i.b)("li",{parentName:"ul"},"Language extensions"),Object(i.b)("li",{parentName:"ul"},"Custom extensions (e.g. allowing users to load support for ",Object(i.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/Azure/azure-rest-api-specs%5Bazure-rest-api-specs%5D"}),"https://github.com/Azure/azure-rest-api-specs[azure-rest-api-specs]"),")"))),Object(i.b)("li",{parentName:"ul"},"Customizable templating engines (handlebars support)"),Object(i.b)("li",{parentName:"ul"},"Unit-testing templates (to previously mentioned explicit type as an interface to the template)"),Object(i.b)("li",{parentName:"ul"},"Reduce coupling"),Object(i.b)("li",{parentName:"ul"},"Make types extending ",Object(i.b)("inlineCode",{parentName:"li"},"CodegenConfig")," become the generation entrypoint"),Object(i.b)("li",{parentName:"ul"},"Allow current ",Object(i.b)("inlineCode",{parentName:"li"},"CodegenConfig")," types to define templating engine"),Object(i.b)("li",{parentName:"ul"},"Allow current ",Object(i.b)("inlineCode",{parentName:"li"},"CodegenConfig")," types to modify workflow (currently encapsulated in ",Object(i.b)("inlineCode",{parentName:"li"},"DefaultGenerator")," and tightly coupled to the template engine"),Object(i.b)("li",{parentName:"ul"},'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.'),Object(i.b)("li",{parentName:"ul"},"Define template deprecation/removal process")),Object(i.b)("h2",{id:"long-term"},"Long-term"),Object(i.b)("blockquote",null,Object(i.b)("p",{parentName:"blockquote"},"Expanding tooling offered, integrations, potentially SaaS offering to partially fund efforts.")),Object(i.b)("ul",null,Object(i.b)("li",{parentName:"ul"},"Generator UI wrappers",Object(i.b)("ul",{parentName:"li"},Object(i.b)("li",{parentName:"ul"},"Move jimschubert/intellij-swagger-codegen plugin under the org, and rename"),Object(i.b)("li",{parentName:"ul"},"Look into an Eclipse UI wrapper around the generator"),Object(i.b)("li",{parentName:"ul"},"Look at Visual Studio Code (and/or Atom, sublime text) integration"))),Object(i.b)("li",{parentName:"ul"},"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."),Object(i.b)("li",{parentName:"ul"},"A paid service (SaaS) for generation may be enticing for some users. Such a service would allow for statistics (mentioned earlier in telemetry)"),Object(i.b)("li",{parentName:"ul"},"Additional tools"),Object(i.b)("li",{parentName:"ul"},"node.js build system(s) integration (grunt/gulp/webpack/etc)"),Object(i.b)("li",{parentName:"ul"},"ruby gem"),Object(i.b)("li",{parentName:"ul"},"others (which may require previously mentioned SaaS API)")))}u.isMDXComponent=!0},296:function(e,t,r){"use strict";r.d(t,"a",(function(){return s})),r.d(t,"b",(function(){return d}));var n=r(0),a=r.n(n);function i(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function l(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var p=a.a.createContext({}),u=function(e){var t=a.a.useContext(p),r=t;return e&&(r="function"==typeof e?e(t):l({},t,{},e)),r},s=function(e){var t=u(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},b={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},m=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,o=e.parentName,p=c(e,["components","mdxType","originalType","parentName"]),s=u(r),m=n,d=s["".concat(o,".").concat(m)]||s[m]||b[m]||i;return r?a.a.createElement(d,l({ref:t},p,{components:r})):a.a.createElement(d,l({ref:t},p))}));function d(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,o=new Array(i);o[0]=m;var l={};for(var c in t)hasOwnProperty.call(t,c)&&(l[c]=t[c]);l.originalType=e,l.mdxType="string"==typeof e?e:n,o[1]=l;for(var p=2;p0&&r.a.createElement("li",{className:u()("menu__list-item",{"menu__list-item--collapsed":f}),key:i},r.a.createElement("a",{className:u()("menu__link",{"menu__link--sublist":c,"menu__link--active":c&&!t.collapsed}),href:"#!",onClick:c?y:void 0},i),r.a.createElement("ul",{className:"menu__list"},l.map((function(e){return r.a.createElement(p,{key:e.label,item:e,onItemClick:n,collapsible:c})}))));case"link":default:return r.a.createElement("li",{className:"menu__list-item",key:i},r.a.createElement(m.a,{activeClassName:"menu__link--active",className:"menu__link",exact:!0,to:o,onClick:n},i))}}var b=function(e){var t=Object(a.useState)(!1),n=t[0],c=t[1],l=e.docsSidebars,o=e.location,i=e.sidebar,s=e.sidebarCollapsible;if(!i)return null;var m=l[i];if(!m)throw new Error('Cannot find the sidebar "'+i+'" in the sidebar config!');return s&&m.forEach((function(e){return function e(t,n){var a=t.items,r=t.href;switch(t.type){case"category":var c=a.map((function(t){return e(t,n)})).filter((function(e){return e})).length>0;return t.collapsed=!c,c;case"link":default:return r===n.pathname.replace(/\/$/,"")}}(e,o)})),r.a.createElement("div",{className:f.a.sidebar},r.a.createElement("div",{className:u()("menu","menu--responsive",{"menu--show":n})},r.a.createElement("button",{"aria-label":n?"Close Menu":"Open Menu",className:"button button--secondary button--sm menu__button",type:"button",onClick:function(){c(!n)}},n?r.a.createElement("span",{className:u()(f.a.sidebarMenuIcon,f.a.sidebarMenuCloseIcon)},"\xd7"):r.a.createElement("svg",{className:f.a.sidebarMenuIcon,xmlns:"http://www.w3.org/2000/svg",height:24,width:24,viewBox:"0 0 32 32",role:"img",focusable:"false"},r.a.createElement("title",null,"Menu"),r.a.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))),r.a.createElement("ul",{className:"menu__list"},m.map((function(e){return r.a.createElement(p,{key:e.label,item:e,onItemClick:function(){c(!1)},collapsible:s})})))))},h=n(307),v=n(312),E=n(310),y=n(147),g=n.n(y);t.default=function(e){var t,n,a=e.route,s=e.docsMetadata,u=e.location,m=s.permalinkToSidebar,d=s.docsSidebars,f=s.version,p=m[u.pathname.replace(/\/$/,"")],y=Object(l.a)().siteConfig,O=(y=void 0===y?{}:y).themeConfig,k=(void 0===O?{}:O).sidebarCollapsible,w=void 0===k||k;return t=a.routes,n=u.pathname,t.some((function(e){return Object(E.b)(n,e)}))?r.a.createElement(i.a,{version:f},r.a.createElement("div",{className:g.a.docPage},p&&r.a.createElement("div",{className:g.a.docSidebarContainer},r.a.createElement(b,{docsSidebars:d,location:u,sidebar:p,sidebarCollapsible:w})),r.a.createElement("main",{className:g.a.docMainContainer},r.a.createElement(c.a,{components:h.a},Object(o.a)(a.routes))))):r.a.createElement(v.default,e)}},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return m})),n.d(t,"b",(function(){return p}));var a=n(0),r=n.n(a);function c(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=r.a.createContext({}),u=function(e){var t=r.a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o({},t,{},e)),n},m=function(e){var t=u(e.components);return r.a.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},f=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,c=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),m=u(n),f=a,p=m["".concat(l,".").concat(f)]||m[f]||d[f]||c;return n?r.a.createElement(p,o({ref:t},s,{components:n})):r.a.createElement(p,o({ref:t},s))}));function p(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var c=n.length,l=new Array(c);l[0]=f;var o={};for(var i in t)hasOwnProperty.call(t,i)&&(o[i]=t[i]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s0&&r.a.createElement("li",{className:u()("menu__list-item",{"menu__list-item--collapsed":f}),key:i},r.a.createElement("a",{className:u()("menu__link",{"menu__link--sublist":c,"menu__link--active":c&&!t.collapsed}),href:"#!",onClick:c?y:void 0},i),r.a.createElement("ul",{className:"menu__list"},l.map((function(e){return r.a.createElement(p,{key:e.label,item:e,onItemClick:n,collapsible:c})}))));case"link":default:return r.a.createElement("li",{className:"menu__list-item",key:i},r.a.createElement(m.a,{activeClassName:"menu__link--active",className:"menu__link",exact:!0,to:o,onClick:n},i))}}var b=function(e){var t=Object(a.useState)(!1),n=t[0],c=t[1],l=e.docsSidebars,o=e.location,i=e.sidebar,s=e.sidebarCollapsible;if(!i)return null;var m=l[i];if(!m)throw new Error('Cannot find the sidebar "'+i+'" in the sidebar config!');return s&&m.forEach((function(e){return function e(t,n){var a=t.items,r=t.href;switch(t.type){case"category":var c=a.map((function(t){return e(t,n)})).filter((function(e){return e})).length>0;return t.collapsed=!c,c;case"link":default:return r===n.pathname.replace(/\/$/,"")}}(e,o)})),r.a.createElement("div",{className:f.a.sidebar},r.a.createElement("div",{className:u()("menu","menu--responsive",{"menu--show":n})},r.a.createElement("button",{"aria-label":n?"Close Menu":"Open Menu",className:"button button--secondary button--sm menu__button",type:"button",onClick:function(){c(!n)}},n?r.a.createElement("span",{className:u()(f.a.sidebarMenuIcon,f.a.sidebarMenuCloseIcon)},"\xd7"):r.a.createElement("svg",{className:f.a.sidebarMenuIcon,xmlns:"http://www.w3.org/2000/svg",height:24,width:24,viewBox:"0 0 32 32",role:"img",focusable:"false"},r.a.createElement("title",null,"Menu"),r.a.createElement("path",{stroke:"currentColor",strokeLinecap:"round",strokeMiterlimit:"10",strokeWidth:"2",d:"M4 7h22M4 15h22M4 23h22"}))),r.a.createElement("ul",{className:"menu__list"},m.map((function(e){return r.a.createElement(p,{key:e.label,item:e,onItemClick:function(){c(!1)},collapsible:s})})))))},h=n(307),v=n(312),E=n(310),y=n(147),g=n.n(y);t.default=function(e){var t,n,a=e.route,s=e.docsMetadata,u=e.location,m=s.permalinkToSidebar,d=s.docsSidebars,f=s.version,p=m[u.pathname.replace(/\/$/,"")],y=Object(l.a)().siteConfig,O=(y=void 0===y?{}:y).themeConfig,k=(void 0===O?{}:O).sidebarCollapsible,w=void 0===k||k;return t=a.routes,n=u.pathname,t.some((function(e){return Object(E.b)(n,e)}))?r.a.createElement(i.a,{version:f},r.a.createElement("div",{className:g.a.docPage},p&&r.a.createElement("div",{className:g.a.docSidebarContainer},r.a.createElement(b,{docsSidebars:d,location:u,sidebar:p,sidebarCollapsible:w})),r.a.createElement("main",{className:g.a.docMainContainer},r.a.createElement(c.a,{components:h.a},Object(o.a)(a.routes))))):r.a.createElement(v.default,e)}},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return m})),n.d(t,"b",(function(){return p}));var a=n(0),r=n.n(a);function c(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var s=r.a.createContext({}),u=function(e){var t=r.a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o({},t,{},e)),n},m=function(e){var t=u(e.components);return r.a.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},f=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,c=e.originalType,l=e.parentName,s=i(e,["components","mdxType","originalType","parentName"]),m=u(n),f=a,p=m["".concat(l,".").concat(f)]||m[f]||d[f]||c;return n?r.a.createElement(p,o({ref:t},s,{components:n})):r.a.createElement(p,o({ref:t},s))}));function p(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var c=n.length,l=new Array(c);l[0]=f;var o={};for(var i in t)hasOwnProperty.call(t,i)&&(o[i]=t[i]);o.originalType=e,o.mdxType="string"==typeof e?e:a,l[1]=o;for(var s=2;s=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=o.a.createContext({}),s=function(e){var t=o.a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},u=function(e){var t=s(e.components);return o.a.createElement(l.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},b=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,a=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),u=s(n),b=r,d=u["".concat(a,".").concat(b)]||u[b]||f[b]||i;return n?o.a.createElement(d,c({ref:t},l,{components:n})):o.a.createElement(d,c({ref:t},l))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,a=new Array(i);a[0]=b;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c.mdxType="string"==typeof e?e:r,a[1]=c;for(var l=2;l=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var l=o.a.createContext({}),s=function(e){var t=o.a.useContext(l),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},u=function(e){var t=s(e.components);return o.a.createElement(l.Provider,{value:t},e.children)},f={inlineCode:"code",wrapper:function(e){var t=e.children;return o.a.createElement(o.a.Fragment,{},t)}},b=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,i=e.originalType,a=e.parentName,l=p(e,["components","mdxType","originalType","parentName"]),u=s(n),b=r,d=u["".concat(a,".").concat(b)]||u[b]||f[b]||i;return n?o.a.createElement(d,c({ref:t},l,{components:n})):o.a.createElement(d,c({ref:t},l))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var i=n.length,a=new Array(i);a[0]=b;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c.mdxType="string"==typeof e?e:r,a[1]=c;for(var l=2;l - + @@ -32,9 +32,9 @@ - + - + diff --git a/7eeb204a.8b156741.js b/7eeb204a.bb152e0d.js similarity index 99% rename from 7eeb204a.8b156741.js rename to 7eeb204a.bb152e0d.js index 1df4df1c427..62fda265298 100644 --- a/7eeb204a.8b156741.js +++ b/7eeb204a.bb152e0d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[69],{198:function(e,a,t){"use strict";t.r(a),t.d(a,"frontMatter",(function(){return n})),t.d(a,"metadata",(function(){return l})),t.d(a,"rightToc",(function(){return s})),t.d(a,"default",(function(){return o}));var r=t(1),c=t(9),b=(t(0),t(296)),n={},l={id:"generators/README",title:"README",description:"\x3c!-- Generate with: openapi-generator list --github-nested-index --\x3e",source:"@site/../docs/generators/README.md",permalink:"/docs/generators/README",editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/generators/README.md",lastUpdatedBy:"William Cheng",lastUpdatedAt:1581087531},s=[{value:"CLIENT generators",id:"client-generators",children:[]},{value:"SERVER generators",id:"server-generators",children:[]},{value:"DOCUMENTATION generators",id:"documentation-generators",children:[]},{value:"SCHEMA generators",id:"schema-generators",children:[]},{value:"CONFIG generators",id:"config-generators",children:[]}],p={rightToc:s};function o(e){var a=e.components,t=Object(c.a)(e,["components"]);return Object(b.b)("wrapper",Object(r.a)({},p,t,{components:a,mdxType:"MDXLayout"}),Object(b.b)("p",null,"The following generators are available:"),Object(b.b)("h2",{id:"client-generators"},"CLIENT generators"),Object(b.b)("ul",null,Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/ada"}),"ada")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/android"}),"android")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/apex"}),"apex")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/bash"}),"bash")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/c"}),"c")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/clojure"}),"clojure")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cpp-qt5-client"}),"cpp-qt5-client")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cpp-restsdk"}),"cpp-restsdk")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cpp-tizen"}),"cpp-tizen")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/csharp"}),"csharp")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/csharp-netcore"}),"csharp-netcore")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/dart"}),"dart")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/dart-dio"}),"dart-dio")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/dart-jaguar"}),"dart-jaguar")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/eiffel"}),"eiffel")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/elixir"}),"elixir")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/elm"}),"elm")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/erlang-client"}),"erlang-client")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/erlang-proper"}),"erlang-proper")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/flash"}),"flash")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/go"}),"go")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/go-experimental"}),"go-experimental (experimental)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/groovy"}),"groovy")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/haskell-http-client"}),"haskell-http-client")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java"}),"java")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/javascript"}),"javascript")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/javascript-closure-angular"}),"javascript-closure-angular")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/javascript-flowtyped"}),"javascript-flowtyped")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-cxf-client"}),"jaxrs-cxf-client")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jmeter"}),"jmeter")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/kotlin"}),"kotlin")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/lua"}),"lua")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/nim"}),"nim (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/objc"}),"objc")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/ocaml"}),"ocaml")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/perl"}),"perl")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php"}),"php")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/powershell"}),"powershell")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/python"}),"python")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/python-experimental"}),"python-experimental (experimental)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/r"}),"r")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/ruby"}),"ruby")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/rust"}),"rust")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scala-akka"}),"scala-akka")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scala-gatling"}),"scala-gatling")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scalaz"}),"scalaz")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/swift4"}),"swift4")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/swift5"}),"swift5 (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-angular"}),"typescript-angular")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-angularjs"}),"typescript-angularjs")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-aurelia"}),"typescript-aurelia")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-axios"}),"typescript-axios")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-fetch"}),"typescript-fetch")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-inversify"}),"typescript-inversify")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-jquery"}),"typescript-jquery")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-node"}),"typescript-node")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-redux-query"}),"typescript-redux-query")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/typescript-rxjs"}),"typescript-rxjs")," ")),Object(b.b)("h2",{id:"server-generators"},"SERVER generators"),Object(b.b)("ul",null,Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/ada-server"}),"ada-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/aspnetcore"}),"aspnetcore")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cpp-pistache-server"}),"cpp-pistache-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cpp-qt5-qhttpengine-server"}),"cpp-qt5-qhttpengine-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cpp-restbed-server"}),"cpp-restbed-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/csharp-nancyfx"}),"csharp-nancyfx")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/erlang-server"}),"erlang-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/fsharp-functions"}),"fsharp-functions (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/fsharp-giraffe-server"}),"fsharp-giraffe-server (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/go-gin-server"}),"go-gin-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/go-server"}),"go-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/graphql-nodejs-express-server"}),"graphql-nodejs-express-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/haskell"}),"haskell")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-inflector"}),"java-inflector")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-msf4j"}),"java-msf4j")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-pkmst"}),"java-pkmst")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-play-framework"}),"java-play-framework")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-undertow-server"}),"java-undertow-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-vertx"}),"java-vertx")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/java-vertx-web"}),"java-vertx-web (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-cxf"}),"jaxrs-cxf")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-cxf-cdi"}),"jaxrs-cxf-cdi")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-cxf-extended"}),"jaxrs-cxf-extended")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-jersey"}),"jaxrs-jersey")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-resteasy"}),"jaxrs-resteasy")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-resteasy-eap"}),"jaxrs-resteasy-eap")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/jaxrs-spec"}),"jaxrs-spec")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/kotlin-server"}),"kotlin-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/kotlin-spring"}),"kotlin-spring")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/kotlin-vertx"}),"kotlin-vertx (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/nodejs-express-server"}),"nodejs-express-server (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php-laravel"}),"php-laravel")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php-lumen"}),"php-lumen")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php-silex"}),"php-silex")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php-slim4"}),"php-slim4")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php-symfony"}),"php-symfony")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/php-ze-ph"}),"php-ze-ph")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/python-aiohttp"}),"python-aiohttp")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/python-blueplanet"}),"python-blueplanet")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/python-flask"}),"python-flask")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/ruby-on-rails"}),"ruby-on-rails")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/ruby-sinatra"}),"ruby-sinatra")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/rust-server"}),"rust-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scala-finch"}),"scala-finch")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scala-lagom-server"}),"scala-lagom-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scala-play-server"}),"scala-play-server")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/scalatra"}),"scalatra")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/spring"}),"spring")," ")),Object(b.b)("h2",{id:"documentation-generators"},"DOCUMENTATION generators"),Object(b.b)("ul",null,Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/asciidoc"}),"asciidoc")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/cwiki"}),"cwiki")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/dynamic-html"}),"dynamic-html")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/html"}),"html")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/html2"}),"html2")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/markdown"}),"markdown (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/openapi"}),"openapi")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/openapi-yaml"}),"openapi-yaml")," ")),Object(b.b)("h2",{id:"schema-generators"},"SCHEMA generators"),Object(b.b)("ul",null,Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/avro-schema"}),"avro-schema (beta)")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/mysql-schema"}),"mysql-schema")," ")),Object(b.b)("h2",{id:"config-generators"},"CONFIG generators"),Object(b.b)("ul",null,Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/apache2"}),"apache2")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/graphql-schema"}),"graphql-schema")," "),Object(b.b)("li",{parentName:"ul"},Object(b.b)("a",Object(r.a)({parentName:"li"},{href:"/docs/generators/protobuf-schema"}),"protobuf-schema (beta)")," ")))}o.isMDXComponent=!0},296:function(e,a,t){"use strict";t.d(a,"a",(function(){return i})),t.d(a,"b",(function(){return m}));var r=t(0),c=t.n(r);function b(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function n(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);a&&(r=r.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,r)}return t}function l(e){for(var a=1;a=0||(c[t]=e[t]);return c}(e,a);if(Object.getOwnPropertySymbols){var b=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(c[t]=e[t])}return c}var p=c.a.createContext({}),o=function(e){var a=c.a.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):l({},a,{},e)),t},i=function(e){var a=o(e.components);return c.a.createElement(p.Provider,{value:a},e.children)},j={inlineCode:"code",wrapper:function(e){var a=e.children;return c.a.createElement(c.a.Fragment,{},a)}},O=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,b=e.originalType,n=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),i=o(t),O=r,m=i["".concat(n,".").concat(O)]||i[O]||j[O]||b;return t?c.a.createElement(m,l({ref:a},p,{components:t})):c.a.createElement(m,l({ref:a},p))}));function m(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var b=t.length,n=new Array(b);n[0]=O;var l={};for(var s in a)hasOwnProperty.call(a,s)&&(l[s]=a[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,n[1]=l;for(var p=2;p=0||(c[t]=e[t]);return c}(e,a);if(Object.getOwnPropertySymbols){var b=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(c[t]=e[t])}return c}var p=c.a.createContext({}),o=function(e){var a=c.a.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):l({},a,{},e)),t},i=function(e){var a=o(e.components);return c.a.createElement(p.Provider,{value:a},e.children)},j={inlineCode:"code",wrapper:function(e){var a=e.children;return c.a.createElement(c.a.Fragment,{},a)}},O=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,b=e.originalType,n=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),i=o(t),O=r,m=i["".concat(n,".").concat(O)]||i[O]||j[O]||b;return t?c.a.createElement(m,l({ref:a},p,{components:t})):c.a.createElement(m,l({ref:a},p))}));function m(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var b=t.length,n=new Array(b);n[0]=O;var l={};for(var s in a)hasOwnProperty.call(a,s)&&(l[s]=a[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,n[1]=l;for(var p=2;p=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=a.a.createContext({}),u=function(e){var t=a.a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},b=function(e){var t=u(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},d=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),b=u(n),d=r,g=b["".concat(i,".").concat(d)]||b[d]||s[d]||o;return n?a.a.createElement(g,c({ref:t},p,{components:n})):a.a.createElement(g,c({ref:t},p))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=d;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:r,i[1]=c;for(var p=2;p=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var p=a.a.createContext({}),u=function(e){var t=a.a.useContext(p),n=t;return e&&(n="function"==typeof e?e(t):i({},t,{},e)),n},b=function(e){var t=u(e.components);return a.a.createElement(p.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},d=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,c=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),b=u(n),d=r,g=b["".concat(c,".").concat(d)]||b[d]||s[d]||o;return n?a.a.createElement(g,i({ref:t},p,{components:n})):a.a.createElement(g,i({ref:t},p))}));function g(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,c=new Array(o);c[0]=d;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:r,c[1]=i;for(var p=2;p=0||(c[t]=e[t]);return c}(e,a);if(Object.getOwnPropertySymbols){var b=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(c[t]=e[t])}return c}var p=c.a.createContext({}),o=function(e){var a=c.a.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):l({},a,{},e)),t},i=function(e){var a=o(e.components);return c.a.createElement(p.Provider,{value:a},e.children)},j={inlineCode:"code",wrapper:function(e){var a=e.children;return c.a.createElement(c.a.Fragment,{},a)}},O=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,b=e.originalType,n=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),i=o(t),O=r,m=i["".concat(n,".").concat(O)]||i[O]||j[O]||b;return t?c.a.createElement(m,l({ref:a},p,{components:t})):c.a.createElement(m,l({ref:a},p))}));function m(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var b=t.length,n=new Array(b);n[0]=O;var l={};for(var s in a)hasOwnProperty.call(a,s)&&(l[s]=a[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,n[1]=l;for(var p=2;p=0||(c[t]=e[t]);return c}(e,a);if(Object.getOwnPropertySymbols){var b=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(c[t]=e[t])}return c}var p=c.a.createContext({}),o=function(e){var a=c.a.useContext(p),t=a;return e&&(t="function"==typeof e?e(a):l({},a,{},e)),t},i=function(e){var a=o(e.components);return c.a.createElement(p.Provider,{value:a},e.children)},j={inlineCode:"code",wrapper:function(e){var a=e.children;return c.a.createElement(c.a.Fragment,{},a)}},O=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,b=e.originalType,n=e.parentName,p=s(e,["components","mdxType","originalType","parentName"]),i=o(t),O=r,m=i["".concat(n,".").concat(O)]||i[O]||j[O]||b;return t?c.a.createElement(m,l({ref:a},p,{components:t})):c.a.createElement(m,l({ref:a},p))}));function m(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var b=t.length,n=new Array(b);n[0]=O;var l={};for(var s in a)hasOwnProperty.call(a,s)&&(l[s]=a[s]);l.originalType=e,l.mdxType="string"==typeof e?e:r,n[1]=l;for(var p=2;p\n io.swagger\n swagger-codegen\n\n")),Object(o.b)("p",null,"New:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator\n\n")),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Cli:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n io.swagger\n swagger-codegen-cli\n\n")),Object(o.b)("p",null,"New:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator-cli\n\n")),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Maven plugin:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n io.swagger\n swagger-codegen-maven-plugin\n\n")),Object(o.b)("p",null,"New:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator-maven-plugin\n\n")),Object(o.b)("h2",{id:"changes-in-maven-plugin"},"Changes in Maven Plugin"),Object(o.b)("p",null,"OpenAPI Generator 3.0.0 has introduced ",Object(o.b)("inlineCode",{parentName:"p"},"")," and deprecated ",Object(o.b)("inlineCode",{parentName:"p"},""),', because this refers to generator names which embed more than just "language".'),Object(o.b)("p",null,"If both options are present, you'll be presented with an error. If only ",Object(o.b)("inlineCode",{parentName:"p"},"")," is provided, you'll be presented instructions for updating to the new config."),Object(o.b)("h2",{id:"new-generators-names"},"New generators names"),Object(o.b)("p",null,"When you run OpenAPI Generator, you need to select a target generator (",Object(o.b)("inlineCode",{parentName:"p"},"-g")," option in the cli).\nAll languages of ",Object(o.b)("inlineCode",{parentName:"p"},"swagger-codegen")," have been migrated to ",Object(o.b)("inlineCode",{parentName:"p"},"openapi-generator"),", but some names were changed, in order to be more consistent."),Object(o.b)("table",null,Object(o.b)("thead",{parentName:"table"},Object(o.b)("tr",{parentName:"thead"},Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"swagger-codegen")),Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"openapi-generator")))),Object(o.b)("tbody",{parentName:"table"},Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"akka-scala")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"scala-akka"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"scala")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"scala-httpclient"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"jaxrs")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"jaxrs-jersey"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"qt5cpp")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpp-qt5"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpprest")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpp-restsdk"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"tizen")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpp-tizen"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"sinatra")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"ruby-sinatra"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swift")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swift2-deprecated"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"lumen")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"php-lumen"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"slim")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"php-slim"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"ze-ph")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"php-ze-ph"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"nancyfx")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"csharp-nancyfx"))))),Object(o.b)("p",null,"We provide a temporary mapping in code for these old values. You'll receive a warning with instructions to migrate to the new names."),Object(o.b)("h2",{id:"new-parameters-name"},"New parameters name"),Object(o.b)("p",null,'Some parameters were renamed.\nOften you need to replace "Swagger", with "OpenAPI".\nSome examples:'),Object(o.b)("table",null,Object(o.b)("thead",{parentName:"table"},Object(o.b)("tr",{parentName:"thead"},Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"swagger-codegen")),Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"openapi-generator")))),Object(o.b)("tbody",{parentName:"table"},Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"debugSwagger")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"debugOpenAPI"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"GenerateSwaggerMetadata")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"GenerateOpenAPIMetadata"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swagger.codegen.undertow.apipackage")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"openapi.codegen.undertow.apipackage"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swagger.codegen.undertow.modelpackage")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"openapi.codegen.undertow.modelpackage"))))),Object(o.b)("h2",{id:"renamed-mustache-template-variables"},"Renamed Mustache Template Variables"),Object(o.b)("p",null,"The template variable ",Object(o.b)("inlineCode",{parentName:"p"},"{{datatype}}")," was renamed to ",Object(o.b)("inlineCode",{parentName:"p"},"{{dataType}}")," for consistency reason.\nCorresponding java code: ",Object(o.b)("inlineCode",{parentName:"p"},"CodegenProperty.datatype")," is renamed to ",Object(o.b)("inlineCode",{parentName:"p"},"CodegenProperty.dataType"),"."),Object(o.b)("p",null,"(If you're ",Object(o.b)("strong",{parentName:"p"},"not")," using customized templates with the ",Object(o.b)("inlineCode",{parentName:"p"},"-t")," option, you can ignore the mustache variable renaming above.)"),Object(o.b)("h2",{id:"ignore-file"},"Ignore file"),Object(o.b)("p",null,Object(o.b)("inlineCode",{parentName:"p"},".swagger-codegen-ignore")," is replaced by ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator-ignore"),".\nThe syntax inside the file stays the same."),Object(o.b)("p",null,"You don't need to rename the file manually, OpenAPI Generator will do it when your run it against an existing output directory.\n(When there is no ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," in a folder, if a ",Object(o.b)("inlineCode",{parentName:"p"},".swagger-codegen-ignore")," file is present it will be considered and renamed to ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator-ignore"),")."),Object(o.b)("h2",{id:"metadata-folder"},"Metadata folder"),Object(o.b)("p",null,"The metatata folder (to store the ",Object(o.b)("inlineCode",{parentName:"p"},"VERSION")," file for example) is now called ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator/")," instead of ",Object(o.b)("inlineCode",{parentName:"p"},".swagger-codegen/"),"."),Object(o.b)("h2",{id:"new-default-values-for-the-generated-code"},"New default values for the generated code"),Object(o.b)("p",null,"If you use a generator without specifying each parameter, you might see some differences in the generated code.\nAs example the default package name used in the generated code has changed.\nYou need to have a look at the specific value, depending of your target language, but often ",Object(o.b)("inlineCode",{parentName:"p"},"Swagger")," \xees replaced by ",Object(o.b)("inlineCode",{parentName:"p"},"OpenAPITools")," and ",Object(o.b)("inlineCode",{parentName:"p"},"io.swagger")," is replaced by ",Object(o.b)("inlineCode",{parentName:"p"},"org.openapitools"),".\nConcretely if you did not specify anything when you are generating java code, a file ",Object(o.b)("inlineCode",{parentName:"p"},"org/openapitools/api/PetApi.java")," might be generated instead of ",Object(o.b)("inlineCode",{parentName:"p"},"io/swagger/api/PetApi.java"),"."),Object(o.b)("p",null,"If this is a problem for you, you need to explicitly set the the parameter value in order to match with the ",Object(o.b)("inlineCode",{parentName:"p"},"swagger-codgen")," default value (",Object(o.b)("inlineCode",{parentName:"p"},"apiPackage")," == ",Object(o.b)("inlineCode",{parentName:"p"},"io.swagger")," in the previous example with the java generator)."),Object(o.b)("h2",{id:"new-fully-qualified-name-for-the-classes"},"New fully qualified name for the classes"),Object(o.b)("p",null,"If you have extended some generators in your project, and you are looking for a specific class, replace the ",Object(o.b)("inlineCode",{parentName:"p"},"io.swagger.codegen")," package (old name) with ",Object(o.b)("inlineCode",{parentName:"p"},"org.openapitools.codegen")," package (new name)."),Object(o.b)("p",null,"Example: ",Object(o.b)("inlineCode",{parentName:"p"},"org.openapitools.codegen.DefaultGenerator")),Object(o.b)("h2",{id:"body-parameter-name"},"Body parameter name"),Object(o.b)("p",null,"\u203c\ufe0f Since 4.0.0-beta, the body parameter name in OAS v2 is automatically preserved in the vendor extension ",Object(o.b)("inlineCode",{parentName:"p"},"x-codegen-request-body-name")),Object(o.b)("p",null,"In OpenAPI spec v3, there's no body parameter, which is replaced by ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#request-body-object"}),"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" parameter is named, please add the vendor extension ',Object(o.b)("inlineCode",{parentName:"p"},"x-codegen-request-body-name")," to the operation:"),Object(o.b)("p",null,"OpenAPI Spec v3:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-yaml"}),"paths:\n /pet:\n post:\n tags:\n - pet\n summary: Add a new pet to the store\n description: ''\n operationId: addPet\n x-codegen-request-body-name: new_body_name\n responses:\n '405':\n description: Invalid input\n security:\n - petstore_auth:\n - 'write:pets'\n - 'read:pets'\n requestBody:\n $ref: '#/components/requestBodies/Pet'\n")),Object(o.b)("p",null,"OpenAPI Spec v2:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-yaml"}),"paths:\n /pet:\n post:\n tags:\n - pet\n summary: Add a new pet to the store\n description: ''\n operationId: addPet\n x-codegen-request-body-name: new_body_name\n consumes:\n - application/json\n - application/xml\n produces:\n - application/xml\n - application/json\n parameters:\n - in: body\n name: body\n description: Pet object that needs to be added to the store\n required: true\n schema:\n $ref: '#/definitions/Pet'\n responses:\n '405':\n description: Invalid input\n security:\n - petstore_auth:\n - 'write:pets'\n - 'read:pets'\n")),Object(o.b)("p",null,"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 ",Object(o.b)("inlineCode",{parentName:"p"},"x-codegen-request-body-name")," to the spec to restore the original body parameter name."),Object(o.b)("h2",{id:"default-basepath"},"Default basePath"),Object(o.b)("p",null,"The default ",Object(o.b)("inlineCode",{parentName:"p"},"basePath")," has been changed from ",Object(o.b)("inlineCode",{parentName:"p"},"https://localhost")," to ",Object(o.b)("inlineCode",{parentName:"p"},"http://localhost")," (http without s)"),Object(o.b)("h2",{id:"nullable"},"Nullable"),Object(o.b)("p",null,"OpenAPI spec v3 has better support for ",Object(o.b)("inlineCode",{parentName:"p"},"nullable"),". If you're still using OpenAPI/Swagger spec v2, please use ",Object(o.b)("inlineCode",{parentName:"p"},"x-nullable: true")," instead."))}c.isMDXComponent=!0},296:function(e,t,a){"use strict";a.d(t,"a",(function(){return d})),a.d(t,"b",(function(){return O}));var n=a(0),r=a.n(n);function o(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function b(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=r.a.createContext({}),c=function(e){var t=r.a.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i({},t,{},e)),a},d=function(e){var t=c(e.components);return r.a.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},s=Object(n.forwardRef)((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,b=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(a),s=n,O=d["".concat(b,".").concat(s)]||d[s]||m[s]||o;return a?r.a.createElement(O,i({ref:t},p,{components:a})):r.a.createElement(O,i({ref:t},p))}));function O(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,b=new Array(o);b[0]=s;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:n,b[1]=i;for(var p=2;p\n io.swagger\n swagger-codegen\n\n")),Object(o.b)("p",null,"New:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator\n\n")),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Cli:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n io.swagger\n swagger-codegen-cli\n\n")),Object(o.b)("p",null,"New:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator-cli\n\n")),Object(o.b)("p",null,Object(o.b)("strong",{parentName:"p"},"Maven plugin:")),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n io.swagger\n swagger-codegen-maven-plugin\n\n")),Object(o.b)("p",null,"New:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator-maven-plugin\n\n")),Object(o.b)("h2",{id:"changes-in-maven-plugin"},"Changes in Maven Plugin"),Object(o.b)("p",null,"OpenAPI Generator 3.0.0 has introduced ",Object(o.b)("inlineCode",{parentName:"p"},"")," and deprecated ",Object(o.b)("inlineCode",{parentName:"p"},""),', because this refers to generator names which embed more than just "language".'),Object(o.b)("p",null,"If both options are present, you'll be presented with an error. If only ",Object(o.b)("inlineCode",{parentName:"p"},"")," is provided, you'll be presented instructions for updating to the new config."),Object(o.b)("h2",{id:"new-generators-names"},"New generators names"),Object(o.b)("p",null,"When you run OpenAPI Generator, you need to select a target generator (",Object(o.b)("inlineCode",{parentName:"p"},"-g")," option in the cli).\nAll languages of ",Object(o.b)("inlineCode",{parentName:"p"},"swagger-codegen")," have been migrated to ",Object(o.b)("inlineCode",{parentName:"p"},"openapi-generator"),", but some names were changed, in order to be more consistent."),Object(o.b)("table",null,Object(o.b)("thead",{parentName:"table"},Object(o.b)("tr",{parentName:"thead"},Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"swagger-codegen")),Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"openapi-generator")))),Object(o.b)("tbody",{parentName:"table"},Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"akka-scala")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"scala-akka"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"scala")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"scala-httpclient"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"jaxrs")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"jaxrs-jersey"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"qt5cpp")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpp-qt5"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpprest")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpp-restsdk"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"tizen")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"cpp-tizen"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"sinatra")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"ruby-sinatra"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swift")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swift2-deprecated"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"lumen")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"php-lumen"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"slim")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"php-slim"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"ze-ph")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"php-ze-ph"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"nancyfx")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"csharp-nancyfx"))))),Object(o.b)("p",null,"We provide a temporary mapping in code for these old values. You'll receive a warning with instructions to migrate to the new names."),Object(o.b)("h2",{id:"new-parameters-name"},"New parameters name"),Object(o.b)("p",null,'Some parameters were renamed.\nOften you need to replace "Swagger", with "OpenAPI".\nSome examples:'),Object(o.b)("table",null,Object(o.b)("thead",{parentName:"table"},Object(o.b)("tr",{parentName:"thead"},Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"swagger-codegen")),Object(o.b)("th",Object(n.a)({parentName:"tr"},{align:null}),"name in ",Object(o.b)("inlineCode",{parentName:"th"},"openapi-generator")))),Object(o.b)("tbody",{parentName:"table"},Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"debugSwagger")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"debugOpenAPI"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"GenerateSwaggerMetadata")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"GenerateOpenAPIMetadata"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swagger.codegen.undertow.apipackage")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"openapi.codegen.undertow.apipackage"))),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"swagger.codegen.undertow.modelpackage")),Object(o.b)("td",Object(n.a)({parentName:"tr"},{align:null}),Object(o.b)("inlineCode",{parentName:"td"},"openapi.codegen.undertow.modelpackage"))))),Object(o.b)("h2",{id:"renamed-mustache-template-variables"},"Renamed Mustache Template Variables"),Object(o.b)("p",null,"The template variable ",Object(o.b)("inlineCode",{parentName:"p"},"{{datatype}}")," was renamed to ",Object(o.b)("inlineCode",{parentName:"p"},"{{dataType}}")," for consistency reason.\nCorresponding java code: ",Object(o.b)("inlineCode",{parentName:"p"},"CodegenProperty.datatype")," is renamed to ",Object(o.b)("inlineCode",{parentName:"p"},"CodegenProperty.dataType"),"."),Object(o.b)("p",null,"(If you're ",Object(o.b)("strong",{parentName:"p"},"not")," using customized templates with the ",Object(o.b)("inlineCode",{parentName:"p"},"-t")," option, you can ignore the mustache variable renaming above.)"),Object(o.b)("h2",{id:"ignore-file"},"Ignore file"),Object(o.b)("p",null,Object(o.b)("inlineCode",{parentName:"p"},".swagger-codegen-ignore")," is replaced by ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator-ignore"),".\nThe syntax inside the file stays the same."),Object(o.b)("p",null,"You don't need to rename the file manually, OpenAPI Generator will do it when your run it against an existing output directory.\n(When there is no ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator-ignore")," in a folder, if a ",Object(o.b)("inlineCode",{parentName:"p"},".swagger-codegen-ignore")," file is present it will be considered and renamed to ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator-ignore"),")."),Object(o.b)("h2",{id:"metadata-folder"},"Metadata folder"),Object(o.b)("p",null,"The metatata folder (to store the ",Object(o.b)("inlineCode",{parentName:"p"},"VERSION")," file for example) is now called ",Object(o.b)("inlineCode",{parentName:"p"},".openapi-generator/")," instead of ",Object(o.b)("inlineCode",{parentName:"p"},".swagger-codegen/"),"."),Object(o.b)("h2",{id:"new-default-values-for-the-generated-code"},"New default values for the generated code"),Object(o.b)("p",null,"If you use a generator without specifying each parameter, you might see some differences in the generated code.\nAs example the default package name used in the generated code has changed.\nYou need to have a look at the specific value, depending of your target language, but often ",Object(o.b)("inlineCode",{parentName:"p"},"Swagger")," \xees replaced by ",Object(o.b)("inlineCode",{parentName:"p"},"OpenAPITools")," and ",Object(o.b)("inlineCode",{parentName:"p"},"io.swagger")," is replaced by ",Object(o.b)("inlineCode",{parentName:"p"},"org.openapitools"),".\nConcretely if you did not specify anything when you are generating java code, a file ",Object(o.b)("inlineCode",{parentName:"p"},"org/openapitools/api/PetApi.java")," might be generated instead of ",Object(o.b)("inlineCode",{parentName:"p"},"io/swagger/api/PetApi.java"),"."),Object(o.b)("p",null,"If this is a problem for you, you need to explicitly set the the parameter value in order to match with the ",Object(o.b)("inlineCode",{parentName:"p"},"swagger-codgen")," default value (",Object(o.b)("inlineCode",{parentName:"p"},"apiPackage")," == ",Object(o.b)("inlineCode",{parentName:"p"},"io.swagger")," in the previous example with the java generator)."),Object(o.b)("h2",{id:"new-fully-qualified-name-for-the-classes"},"New fully qualified name for the classes"),Object(o.b)("p",null,"If you have extended some generators in your project, and you are looking for a specific class, replace the ",Object(o.b)("inlineCode",{parentName:"p"},"io.swagger.codegen")," package (old name) with ",Object(o.b)("inlineCode",{parentName:"p"},"org.openapitools.codegen")," package (new name)."),Object(o.b)("p",null,"Example: ",Object(o.b)("inlineCode",{parentName:"p"},"org.openapitools.codegen.DefaultGenerator")),Object(o.b)("h2",{id:"body-parameter-name"},"Body parameter name"),Object(o.b)("p",null,"\u203c\ufe0f Since 4.0.0-beta, the body parameter name in OAS v2 is automatically preserved in the vendor extension ",Object(o.b)("inlineCode",{parentName:"p"},"x-codegen-request-body-name")),Object(o.b)("p",null,"In OpenAPI spec v3, there's no body parameter, which is replaced by ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#request-body-object"}),"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" parameter is named, please add the vendor extension ',Object(o.b)("inlineCode",{parentName:"p"},"x-codegen-request-body-name")," to the operation:"),Object(o.b)("p",null,"OpenAPI Spec v3:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-yaml"}),"paths:\n /pet:\n post:\n tags:\n - pet\n summary: Add a new pet to the store\n description: ''\n operationId: addPet\n x-codegen-request-body-name: new_body_name\n responses:\n '405':\n description: Invalid input\n security:\n - petstore_auth:\n - 'write:pets'\n - 'read:pets'\n requestBody:\n $ref: '#/components/requestBodies/Pet'\n")),Object(o.b)("p",null,"OpenAPI Spec v2:"),Object(o.b)("pre",null,Object(o.b)("code",Object(n.a)({parentName:"pre"},{className:"language-yaml"}),"paths:\n /pet:\n post:\n tags:\n - pet\n summary: Add a new pet to the store\n description: ''\n operationId: addPet\n x-codegen-request-body-name: new_body_name\n consumes:\n - application/json\n - application/xml\n produces:\n - application/xml\n - application/json\n parameters:\n - in: body\n name: body\n description: Pet object that needs to be added to the store\n required: true\n schema:\n $ref: '#/definitions/Pet'\n responses:\n '405':\n description: Invalid input\n security:\n - petstore_auth:\n - 'write:pets'\n - 'read:pets'\n")),Object(o.b)("p",null,"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 ",Object(o.b)("inlineCode",{parentName:"p"},"x-codegen-request-body-name")," to the spec to restore the original body parameter name."),Object(o.b)("h2",{id:"default-basepath"},"Default basePath"),Object(o.b)("p",null,"The default ",Object(o.b)("inlineCode",{parentName:"p"},"basePath")," has been changed from ",Object(o.b)("inlineCode",{parentName:"p"},"https://localhost")," to ",Object(o.b)("inlineCode",{parentName:"p"},"http://localhost")," (http without s)"),Object(o.b)("h2",{id:"nullable"},"Nullable"),Object(o.b)("p",null,"OpenAPI spec v3 has better support for ",Object(o.b)("inlineCode",{parentName:"p"},"nullable"),". If you're still using OpenAPI/Swagger spec v2, please use ",Object(o.b)("inlineCode",{parentName:"p"},"x-nullable: true")," instead."))}c.isMDXComponent=!0},296:function(e,t,a){"use strict";a.d(t,"a",(function(){return d})),a.d(t,"b",(function(){return O}));var n=a(0),r=a.n(n);function o(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function b(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function i(e){for(var t=1;t=0||(r[a]=e[a]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(r[a]=e[a])}return r}var p=r.a.createContext({}),c=function(e){var t=r.a.useContext(p),a=t;return e&&(a="function"==typeof e?e(t):i({},t,{},e)),a},d=function(e){var t=c(e.components);return r.a.createElement(p.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},s=Object(n.forwardRef)((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,b=e.parentName,p=l(e,["components","mdxType","originalType","parentName"]),d=c(a),s=n,O=d["".concat(b,".").concat(s)]||d[s]||m[s]||o;return a?r.a.createElement(O,i({ref:t},p,{components:a})):r.a.createElement(O,i({ref:t},p))}));function O(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,b=new Array(o);b[0]=s;var i={};for(var l in t)hasOwnProperty.call(t,l)&&(i[l]=t[l]);i.originalType=e,i.mdxType="string"==typeof e?e:n,b[1]=i;for(var p=2;p=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var b=a.a.createContext({}),p=function(e){var t=a.a.useContext(b),r=t;return e&&(r="function"==typeof e?e(t):l({},t,{},e)),r},s=function(e){var t=p(e.components);return a.a.createElement(b.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},m=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,o=e.parentName,b=i(e,["components","mdxType","originalType","parentName"]),s=p(r),m=n,d=s["".concat(o,".").concat(m)]||s[m]||u[m]||c;return r?a.a.createElement(d,l({ref:t},b,{components:r})):a.a.createElement(d,l({ref:t},b))}));function d(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=m;var l={};for(var i in t)hasOwnProperty.call(t,i)&&(l[i]=t[i]);l.originalType=e,l.mdxType="string"==typeof e?e:n,o[1]=l;for(var b=2;b=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var b=a.a.createContext({}),p=function(e){var t=a.a.useContext(b),r=t;return e&&(r="function"==typeof e?e(t):l({},t,{},e)),r},s=function(e){var t=p(e.components);return a.a.createElement(b.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},d=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,o=e.parentName,b=i(e,["components","mdxType","originalType","parentName"]),s=p(r),d=n,m=s["".concat(o,".").concat(d)]||s[d]||u[d]||c;return r?a.a.createElement(m,l({ref:t},b,{components:r})):a.a.createElement(m,l({ref:t},b))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=d;var l={};for(var i in t)hasOwnProperty.call(t,i)&&(l[i]=t[i]);l.originalType=e,l.mdxType="string"==typeof e?e:n,o[1]=l;for(var b=2;b=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var m=n.a.createContext({}),s=function(e){var a=n.a.useContext(m),t=a;return e&&(t="function"==typeof e?e(a):o({},a,{},e)),t},u=function(e){var a=s(e.components);return n.a.createElement(m.Provider,{value:a},e.children)},p={inlineCode:"code",wrapper:function(e){var a=e.children;return n.a.createElement(n.a.Fragment,{},a)}},f=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,l=e.originalType,c=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),u=s(t),f=r,d=u["".concat(c,".").concat(f)]||u[f]||p[f]||l;return t?n.a.createElement(d,o({ref:a},m,{components:t})):n.a.createElement(d,o({ref:a},m))}));function d(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var l=t.length,c=new Array(l);c[0]=f;var o={};for(var i in a)hasOwnProperty.call(a,i)&&(o[i]=a[i]);o.originalType=e,o.mdxType="string"==typeof e?e:r,c[1]=o;for(var m=2;m0||g)&&n.a.createElement("footer",{className:"row margin-vert--lg"},N.length>0&&n.a.createElement("div",{className:"col"},n.a.createElement("strong",null,"Tags:"),N.map((function(e){var a=e.label,t=e.permalink;return n.a.createElement(i.a,{key:t,className:"margin-horiz--sm",to:t},a)}))),g&&n.a.createElement("div",{className:"col text--right"},n.a.createElement(i.a,{to:v.permalink,"aria-label":"Read more about "+_},n.a.createElement("strong",null,"Read More")))))}}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[97],{292:function(e,a,t){"use strict";t.r(a);var r=t(0),n=t.n(r),l=t(301),c=t(311),o=t(299);var i=function(e){var a=e.metadata,t=a.previousPage,r=a.nextPage;return n.a.createElement("nav",{className:"pagination-nav"},n.a.createElement("div",{className:"pagination-nav__item"},t&&n.a.createElement(o.a,{className:"pagination-nav__link",to:t},n.a.createElement("h4",{className:"pagination-nav__link--label"},"\xab Newer Entries"))),n.a.createElement("div",{className:"pagination-nav__item pagination-nav__item--next"},r&&n.a.createElement(o.a,{className:"pagination-nav__link",to:r},n.a.createElement("h4",{className:"pagination-nav__link--label"},"Older Entries \xbb"))))};a.default=function(e){var a=e.metadata,t=e.items;return n.a.createElement(l.a,{title:"Blog",description:"Blog"},n.a.createElement("div",{className:"container margin-vert--xl"},n.a.createElement("div",{className:"row"},n.a.createElement("div",{className:"col col--8 col--offset-2"},t.map((function(e){var a=e.content;return n.a.createElement(c.a,{key:a.metadata.permalink,frontMatter:a.frontMatter,metadata:a.metadata,truncated:!0},n.a.createElement(a,null))})),n.a.createElement(i,{metadata:a})))))}},296:function(e,a,t){"use strict";t.d(a,"a",(function(){return u})),t.d(a,"b",(function(){return d}));var r=t(0),n=t.n(r);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function c(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);a&&(r=r.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var a=1;a=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var m=n.a.createContext({}),s=function(e){var a=n.a.useContext(m),t=a;return e&&(t="function"==typeof e?e(a):o({},a,{},e)),t},u=function(e){var a=s(e.components);return n.a.createElement(m.Provider,{value:a},e.children)},p={inlineCode:"code",wrapper:function(e){var a=e.children;return n.a.createElement(n.a.Fragment,{},a)}},f=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,l=e.originalType,c=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),u=s(t),f=r,d=u["".concat(c,".").concat(f)]||u[f]||p[f]||l;return t?n.a.createElement(d,o({ref:a},m,{components:t})):n.a.createElement(d,o({ref:a},m))}));function d(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var l=t.length,c=new Array(l);c[0]=f;var o={};for(var i in a)hasOwnProperty.call(a,i)&&(o[i]=a[i]);o.originalType=e,o.mdxType="string"==typeof e?e:r,c[1]=o;for(var m=2;m0||g)&&n.a.createElement("footer",{className:"row margin-vert--lg"},N.length>0&&n.a.createElement("div",{className:"col"},n.a.createElement("strong",null,"Tags:"),N.map((function(e){var a=e.label,t=e.permalink;return n.a.createElement(i.a,{key:t,className:"margin-horiz--sm",to:t},a)}))),g&&n.a.createElement("div",{className:"col text--right"},n.a.createElement(i.a,{to:v.permalink,"aria-label":"Read more about "+_},n.a.createElement("strong",null,"Read More")))))}}}]); \ No newline at end of file diff --git a/ac8b7f2e.614520c4.js b/ac8b7f2e.5e388b27.js similarity index 96% rename from ac8b7f2e.614520c4.js rename to ac8b7f2e.5e388b27.js index d93b3a9dc9c..a698e82d74e 100644 --- a/ac8b7f2e.614520c4.js +++ b/ac8b7f2e.5e388b27.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{232:function(e,t,r){"use strict";r.r(t),r.d(t,"frontMatter",(function(){return o})),r.d(t,"metadata",(function(){return i})),r.d(t,"rightToc",(function(){return p})),r.d(t,"default",(function(){return u}));var n=r(1),a=r(9),c=(r(0),r(296)),o={id:"core-team",title:"Core Team Members"},i={id:"core-team",title:"Core Team Members",description:"* [@wing328](https://github.com/wing328) (2015/07)",source:"@site/../docs/core-team.md",permalink:"/docs/core-team",editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/core-team.md",lastUpdatedBy:"William Cheng",lastUpdatedAt:1581087531},p=[],b={rightToc:p};function u(e){var t=e.components,r=Object(a.a)(e,["components"]);return Object(c.b)("wrapper",Object(n.a)({},b,r,{components:t,mdxType:"MDXLayout"}),Object(c.b)("ul",null,Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/wing328"}),"@wing328")," (2015/07)"),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/jimschubert"}),"@jimschubert")," (2016/05)"),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/cbornet"}),"@cbornet")," (2016/05)"),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/jaz-ah"}),"@jaz-ah")," (2016/05)"),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/ackintosh"}),"@ackintosh")," (2018/02)"),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/JFCote"}),"@JFCote")," (2018/03)"),Object(c.b)("li",{parentName:"ul"},Object(c.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/jmini"}),"@jmini")," (2018/04)")))}u.isMDXComponent=!0},296:function(e,t,r){"use strict";r.d(t,"a",(function(){return l})),r.d(t,"b",(function(){return f}));var n=r(0),a=r.n(n);function c(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function o(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,n)}return r}function i(e){for(var t=1;t=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var b=a.a.createContext({}),u=function(e){var t=a.a.useContext(b),r=t;return e&&(r="function"==typeof e?e(t):i({},t,{},e)),r},l=function(e){var t=u(e.components);return a.a.createElement(b.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},s=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,o=e.parentName,b=p(e,["components","mdxType","originalType","parentName"]),l=u(r),s=n,f=l["".concat(o,".").concat(s)]||l[s]||m[s]||c;return r?a.a.createElement(f,i({ref:t},b,{components:r})):a.a.createElement(f,i({ref:t},b))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=s;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:n,o[1]=i;for(var b=2;b=0||(a[r]=e[r]);return a}(e,t);if(Object.getOwnPropertySymbols){var c=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(a[r]=e[r])}return a}var b=a.a.createContext({}),u=function(e){var t=a.a.useContext(b),r=t;return e&&(r="function"==typeof e?e(t):i({},t,{},e)),r},l=function(e){var t=u(e.components);return a.a.createElement(b.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},s=Object(n.forwardRef)((function(e,t){var r=e.components,n=e.mdxType,c=e.originalType,o=e.parentName,b=p(e,["components","mdxType","originalType","parentName"]),l=u(r),s=n,f=l["".concat(o,".").concat(s)]||l[s]||m[s]||c;return r?a.a.createElement(f,i({ref:t},b,{components:r})):a.a.createElement(f,i({ref:t},b))}));function f(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var c=r.length,o=new Array(c);o[0]=s;var i={};for(var p in t)hasOwnProperty.call(t,p)&&(i[p]=t[p]);i.originalType=e,i.mdxType="string"==typeof e?e:n,o[1]=i;for(var b=2;b - + @@ -32,15 +32,15 @@ - + - + - + diff --git a/blog/index.html b/blog/index.html index e7fa5f1eaf2..9e6d9edcdd7 100644 --- a/blog/index.html +++ b/blog/index.html @@ -21,7 +21,7 @@ - + @@ -32,15 +32,15 @@ - + - + - + diff --git a/c4f5d8e4.e07a2691.js b/c4f5d8e4.3a897df1.js similarity index 99% rename from c4f5d8e4.e07a2691.js rename to c4f5d8e4.3a897df1.js index ba0d1960c10..a0e36d54e49 100644 --- a/c4f5d8e4.e07a2691.js +++ b/c4f5d8e4.3a897df1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{294:function(e,a,t){"use strict";t.r(a);var n=t(1);function l(e,a){return a||(a=e.slice(0)),e.raw=a,e}t(308);var r=t(0),o=t.n(r),c=t(297),s=t.n(c),i=t(301),m=t(299),u=t(298),p=t(300),g=t(128),d=t.n(g),E=t(309);function h(){var e=l(["\n |docker run --rm \\\n | -v $PWD:/local openapitools/openapi-generator-cli generate \\\n | -i /local/petstore.yaml \\\n | -g go \\\n | -o /local/out/go\n "],["\n |docker run --rm \\\\\n | -v $PWD:/local openapitools/openapi-generator-cli generate \\\\\n | -i /local/petstore.yaml \\\\\n | -g go \\\\\n | -o /local/out/go\n "]);return h=function(){return e},e}function f(){var e=l(['\n |# install the latest version of "openapi-generator-cli"\n |npm install @openapitools/openapi-generator-cli -g\n |\n |# install a specific version of "openapi-generator-cli"\n |npm install @openapitools/openapi-generator-cli@cli-4.2.3 -g\n |\n |# Or install it as dev-dependency in your node.js projects\n |npm install @openapitools/openapi-generator-cli -D\n ']);return f=function(){return e},e}var b=[{title:o.a.createElement(o.a.Fragment,null,"Easy to Use"),imageUrl:"img/icons/plug.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"With ",o.a.createElement("em",null,"50+")," client generators, you can easily generate code to interact with any server which exposes an OpenAPI document."),o.a.createElement("p",null,"Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs."),o.a.createElement("p",null,"Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates."),"See ",o.a.createElement("a",{href:"./docs/customization"},"Customization")," for details.")},{title:o.a.createElement(o.a.Fragment,null,"Servers"),imageUrl:"img/icons/exchange.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"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."),o.a.createElement("p",null,"Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP."),o.a.createElement("p",null,"Some generators support ",o.a.createElement("em",null,"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."))},{title:o.a.createElement(o.a.Fragment,null,"Schemas/Configs"),imageUrl:"img/icons/pencil.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?"),o.a.createElement("p",null,"OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators."),o.a.createElement("p",null,"You can easily extend these generators and their templates to create derivative generators!"))},{title:o.a.createElement(o.a.Fragment,null,"Documentation"),imageUrl:"img/icons/newspaper-o.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"OpenAPI documents allow you to convert the metadata about your API into some other format."),o.a.createElement("p",null,"We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers."),o.a.createElement("p",null,"We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents."))}];function v(e){for(var a=arguments.length,t=new Array(a>1?a-1:0),n=1;n"},o.a.createElement("header",{className:s()("hero hero--primary",d.a.heroBanner)},o.a.createElement("div",{className:"container"},o.a.createElement("h1",{className:"hero__title"},a.title),o.a.createElement("p",{className:"hero__subtitle"},a.tagline),o.a.createElement("div",{className:d.a.buttons},o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--lg",d.a.getStarted),to:Object(p.a)("#try")},"Try It Out"),o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--lg",d.a.getStarted),to:Object(p.a)("docs/installation")},"Install")),o.a.createElement("div",{className:d.a.buttons},o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--md",d.a.getStarted),to:Object(p.a)("docs/generators")},"Generators"),o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--md",d.a.getStarted),to:Object(p.a)("docs/customization")},"Customization"),o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--md",d.a.getStarted),to:Object(p.a)("docs/integrations")},"Integrations")))),o.a.createElement("div",{className:s()(d.a.announcement,d.a.announcementDark)},o.a.createElement("div",{className:d.a.announcementInner},o.a.createElement("h2",null,o.a.createElement("b",null,"Sponsors")),o.a.createElement("p",null,"If you find OpenAPI Generator useful, please consider asking your company to ",o.a.createElement("a",{href:"https://opencollective.com/openapi_generator"},"become a sponsor"),"."),o.a.createElement("p",null,"You can also individually sponsor the project by ",o.a.createElement("a",{href:"https://opencollective.com/openapi_generator"},"becoming a backer"),"."),o.a.createElement("h3",null,"Thank you to our bronze sponsors!"),o.a.createElement("div",{className:s()("avatar",d.a.bronzeSponsorAvatars)},r.filter((function(e){return e.bronze})).map((function(e){return o.a.createElement("a",{className:s()("avatar__photo-link bronze-sponsor"),href:e.infoLink,key:e.infoLink},o.a.createElement("img",{src:Object(p.a)(e.image),alt:e.caption,title:e.caption,className:s()("avatar__photo avatar__photo--lg")}))}))))),o.a.createElement("main",null,b&&b.length&&o.a.createElement("section",{className:d.a.features},o.a.createElement("div",{className:"features container"},o.a.createElement("div",{className:"row"},b.map((function(e,a){return o.a.createElement(N,Object(n.a)({key:a},e))}))))),y&&y.length&&o.a.createElement("section",{className:d.a.callout},o.a.createElement("div",{className:"callout container"},y.map((function(e,a){return o.a.createElement(w,Object(n.a)({key:a},e))}))))),g&&g.length&&o.a.createElement("div",{className:s()(d.a.announcement,d.a.announcementLight)},o.a.createElement("div",{className:s()(d.a.productShowcaseSection,d.a.announcementInner)},o.a.createElement(I,{users:g}))),o.a.createElement("div",{className:s()(d.a.announcement,d.a.announcementDark)},'"OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)'))}}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{293:function(e,a,t){"use strict";t.r(a);var n=t(1);function l(e,a){return a||(a=e.slice(0)),e.raw=a,e}t(308);var r=t(0),o=t.n(r),c=t(297),s=t.n(c),i=t(301),m=t(299),u=t(298),p=t(300),g=t(128),d=t.n(g),E=t(309);function h(){var e=l(["\n |docker run --rm \\\n | -v $PWD:/local openapitools/openapi-generator-cli generate \\\n | -i /local/petstore.yaml \\\n | -g go \\\n | -o /local/out/go\n "],["\n |docker run --rm \\\\\n | -v $PWD:/local openapitools/openapi-generator-cli generate \\\\\n | -i /local/petstore.yaml \\\\\n | -g go \\\\\n | -o /local/out/go\n "]);return h=function(){return e},e}function f(){var e=l(['\n |# install the latest version of "openapi-generator-cli"\n |npm install @openapitools/openapi-generator-cli -g\n |\n |# install a specific version of "openapi-generator-cli"\n |npm install @openapitools/openapi-generator-cli@cli-4.2.3 -g\n |\n |# Or install it as dev-dependency in your node.js projects\n |npm install @openapitools/openapi-generator-cli -D\n ']);return f=function(){return e},e}var b=[{title:o.a.createElement(o.a.Fragment,null,"Easy to Use"),imageUrl:"img/icons/plug.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"With ",o.a.createElement("em",null,"50+")," client generators, you can easily generate code to interact with any server which exposes an OpenAPI document."),o.a.createElement("p",null,"Maintainers of APIs may also automatically generate and distribute clients as part of official SDKs."),o.a.createElement("p",null,"Each client supports different options and features, but all templates can be replaced with your own Mustache-based templates."),"See ",o.a.createElement("a",{href:"./docs/customization"},"Customization")," for details.")},{title:o.a.createElement(o.a.Fragment,null,"Servers"),imageUrl:"img/icons/exchange.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"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."),o.a.createElement("p",null,"Generate server stubs for 40+ different languages and technologies, including Java, Kotlin, Go, and PHP."),o.a.createElement("p",null,"Some generators support ",o.a.createElement("em",null,"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."))},{title:o.a.createElement(o.a.Fragment,null,"Schemas/Configs"),imageUrl:"img/icons/pencil.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"Ever wanted to iteratively design a MySQL database, but writing table declarations was too tedious?"),o.a.createElement("p",null,"OpenAPI Generator offers some special generators such as Apache2 Configuration, MySQL and GraphQL schema generators."),o.a.createElement("p",null,"You can easily extend these generators and their templates to create derivative generators!"))},{title:o.a.createElement(o.a.Fragment,null,"Documentation"),imageUrl:"img/icons/newspaper-o.svg",description:o.a.createElement(o.a.Fragment,null,o.a.createElement("p",null,"OpenAPI documents allow you to convert the metadata about your API into some other format."),o.a.createElement("p",null,"We include documentation formats such as HTML and Cwiki, which allow you to distribute static documentation to your consumers."),o.a.createElement("p",null,"We also support generating from OpenAPI 2.0 to newer JSON/YAML OpenAPI 3.x documents."))}];function v(e){for(var a=arguments.length,t=new Array(a>1?a-1:0),n=1;n"},o.a.createElement("header",{className:s()("hero hero--primary",d.a.heroBanner)},o.a.createElement("div",{className:"container"},o.a.createElement("h1",{className:"hero__title"},a.title),o.a.createElement("p",{className:"hero__subtitle"},a.tagline),o.a.createElement("div",{className:d.a.buttons},o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--lg",d.a.getStarted),to:Object(p.a)("#try")},"Try It Out"),o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--lg",d.a.getStarted),to:Object(p.a)("docs/installation")},"Install")),o.a.createElement("div",{className:d.a.buttons},o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--md",d.a.getStarted),to:Object(p.a)("docs/generators")},"Generators"),o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--md",d.a.getStarted),to:Object(p.a)("docs/customization")},"Customization"),o.a.createElement(m.a,{className:s()("button button--outline button--secondary button--md",d.a.getStarted),to:Object(p.a)("docs/integrations")},"Integrations")))),o.a.createElement("div",{className:s()(d.a.announcement,d.a.announcementDark)},o.a.createElement("div",{className:d.a.announcementInner},o.a.createElement("h2",null,o.a.createElement("b",null,"Sponsors")),o.a.createElement("p",null,"If you find OpenAPI Generator useful, please consider asking your company to ",o.a.createElement("a",{href:"https://opencollective.com/openapi_generator"},"become a sponsor"),"."),o.a.createElement("p",null,"You can also individually sponsor the project by ",o.a.createElement("a",{href:"https://opencollective.com/openapi_generator"},"becoming a backer"),"."),o.a.createElement("h3",null,"Thank you to our bronze sponsors!"),o.a.createElement("div",{className:s()("avatar",d.a.bronzeSponsorAvatars)},r.filter((function(e){return e.bronze})).map((function(e){return o.a.createElement("a",{className:s()("avatar__photo-link bronze-sponsor"),href:e.infoLink,key:e.infoLink},o.a.createElement("img",{src:Object(p.a)(e.image),alt:e.caption,title:e.caption,className:s()("avatar__photo avatar__photo--lg")}))}))))),o.a.createElement("main",null,b&&b.length&&o.a.createElement("section",{className:d.a.features},o.a.createElement("div",{className:"features container"},o.a.createElement("div",{className:"row"},b.map((function(e,a){return o.a.createElement(N,Object(n.a)({key:a},e))}))))),y&&y.length&&o.a.createElement("section",{className:d.a.callout},o.a.createElement("div",{className:"callout container"},y.map((function(e,a){return o.a.createElement(w,Object(n.a)({key:a},e))}))))),g&&g.length&&o.a.createElement("div",{className:s()(d.a.announcement,d.a.announcementLight)},o.a.createElement("div",{className:s()(d.a.productShowcaseSection,d.a.announcementInner)},o.a.createElement(I,{users:g}))),o.a.createElement("div",{className:s()(d.a.announcement,d.a.announcementDark)},'"OpenAPI Tools" and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI)'))}}}]); \ No newline at end of file diff --git a/ccc49370.2bf40702.js b/ccc49370.76505ab1.js similarity index 99% rename from ccc49370.2bf40702.js rename to ccc49370.76505ab1.js index 7bf2bb9cd97..49fdff638c8 100644 --- a/ccc49370.2bf40702.js +++ b/ccc49370.76505ab1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{295:function(e,a,t){"use strict";t.r(a);var r=t(0),n=t.n(r),l=t(301),c=t(311),o=t(299);var i=function(e){var a=e.nextItem,t=e.prevItem;return n.a.createElement("nav",{className:"pagination-nav"},n.a.createElement("div",{className:"pagination-nav__item"},t&&n.a.createElement(o.a,{className:"pagination-nav__link",to:t.permalink},n.a.createElement("h5",{className:"pagination-nav__link--sublabel"},"Previous Post"),n.a.createElement("h4",{className:"pagination-nav__link--label"},"\xab ",t.title))),n.a.createElement("div",{className:"pagination-nav__item pagination-nav__item--next"},a&&n.a.createElement(o.a,{className:"pagination-nav__link",to:a.permalink},n.a.createElement("h5",{className:"pagination-nav__link--sublabel"},"Next Post"),n.a.createElement("h4",{className:"pagination-nav__link--label"},a.title," \xbb"))))};a.default=function(e){var a=e.content,t=a.frontMatter,r=a.metadata;return n.a.createElement(l.a,{title:r.title,description:r.description},a&&n.a.createElement("div",{className:"container margin-vert--xl"},n.a.createElement("div",{className:"row"},n.a.createElement("div",{className:"col col--8 col--offset-2"},n.a.createElement(c.a,{frontMatter:t,metadata:r,isBlogPostPage:!0},n.a.createElement(a,null)),(r.nextItem||r.prevItem)&&n.a.createElement("div",{className:"margin-vert--xl"},n.a.createElement(i,{nextItem:r.nextItem,prevItem:r.prevItem}))))))}},296:function(e,a,t){"use strict";t.d(a,"a",(function(){return u})),t.d(a,"b",(function(){return f}));var r=t(0),n=t.n(r);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function c(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);a&&(r=r.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var a=1;a=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var m=n.a.createContext({}),s=function(e){var a=n.a.useContext(m),t=a;return e&&(t="function"==typeof e?e(a):o({},a,{},e)),t},u=function(e){var a=s(e.components);return n.a.createElement(m.Provider,{value:a},e.children)},p={inlineCode:"code",wrapper:function(e){var a=e.children;return n.a.createElement(n.a.Fragment,{},a)}},v=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,l=e.originalType,c=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),u=s(t),v=r,f=u["".concat(c,".").concat(v)]||u[v]||p[v]||l;return t?n.a.createElement(f,o({ref:a},m,{components:t})):n.a.createElement(f,o({ref:a},m))}));function f(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var l=t.length,c=new Array(l);c[0]=v;var o={};for(var i in a)hasOwnProperty.call(a,i)&&(o[i]=a[i]);o.originalType=e,o.mdxType="string"==typeof e?e:r,c[1]=o;for(var m=2;m0||g)&&n.a.createElement("footer",{className:"row margin-vert--lg"},N.length>0&&n.a.createElement("div",{className:"col"},n.a.createElement("strong",null,"Tags:"),N.map((function(e){var a=e.label,t=e.permalink;return n.a.createElement(i.a,{key:t,className:"margin-horiz--sm",to:t},a)}))),g&&n.a.createElement("div",{className:"col text--right"},n.a.createElement(i.a,{to:d.permalink,"aria-label":"Read more about "+O},n.a.createElement("strong",null,"Read More")))))}}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{294:function(e,a,t){"use strict";t.r(a);var r=t(0),n=t.n(r),l=t(301),c=t(311),o=t(299);var i=function(e){var a=e.nextItem,t=e.prevItem;return n.a.createElement("nav",{className:"pagination-nav"},n.a.createElement("div",{className:"pagination-nav__item"},t&&n.a.createElement(o.a,{className:"pagination-nav__link",to:t.permalink},n.a.createElement("h5",{className:"pagination-nav__link--sublabel"},"Previous Post"),n.a.createElement("h4",{className:"pagination-nav__link--label"},"\xab ",t.title))),n.a.createElement("div",{className:"pagination-nav__item pagination-nav__item--next"},a&&n.a.createElement(o.a,{className:"pagination-nav__link",to:a.permalink},n.a.createElement("h5",{className:"pagination-nav__link--sublabel"},"Next Post"),n.a.createElement("h4",{className:"pagination-nav__link--label"},a.title," \xbb"))))};a.default=function(e){var a=e.content,t=a.frontMatter,r=a.metadata;return n.a.createElement(l.a,{title:r.title,description:r.description},a&&n.a.createElement("div",{className:"container margin-vert--xl"},n.a.createElement("div",{className:"row"},n.a.createElement("div",{className:"col col--8 col--offset-2"},n.a.createElement(c.a,{frontMatter:t,metadata:r,isBlogPostPage:!0},n.a.createElement(a,null)),(r.nextItem||r.prevItem)&&n.a.createElement("div",{className:"margin-vert--xl"},n.a.createElement(i,{nextItem:r.nextItem,prevItem:r.prevItem}))))))}},296:function(e,a,t){"use strict";t.d(a,"a",(function(){return u})),t.d(a,"b",(function(){return f}));var r=t(0),n=t.n(r);function l(e,a,t){return a in e?Object.defineProperty(e,a,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[a]=t,e}function c(e,a){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);a&&(r=r.filter((function(a){return Object.getOwnPropertyDescriptor(e,a).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var a=1;a=0||(n[t]=e[t]);return n}(e,a);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var m=n.a.createContext({}),s=function(e){var a=n.a.useContext(m),t=a;return e&&(t="function"==typeof e?e(a):o({},a,{},e)),t},u=function(e){var a=s(e.components);return n.a.createElement(m.Provider,{value:a},e.children)},p={inlineCode:"code",wrapper:function(e){var a=e.children;return n.a.createElement(n.a.Fragment,{},a)}},v=Object(r.forwardRef)((function(e,a){var t=e.components,r=e.mdxType,l=e.originalType,c=e.parentName,m=i(e,["components","mdxType","originalType","parentName"]),u=s(t),v=r,f=u["".concat(c,".").concat(v)]||u[v]||p[v]||l;return t?n.a.createElement(f,o({ref:a},m,{components:t})):n.a.createElement(f,o({ref:a},m))}));function f(e,a){var t=arguments,r=a&&a.mdxType;if("string"==typeof e||r){var l=t.length,c=new Array(l);c[0]=v;var o={};for(var i in a)hasOwnProperty.call(a,i)&&(o[i]=a[i]);o.originalType=e,o.mdxType="string"==typeof e?e:r,c[1]=o;for(var m=2;m0||g)&&n.a.createElement("footer",{className:"row margin-vert--lg"},N.length>0&&n.a.createElement("div",{className:"col"},n.a.createElement("strong",null,"Tags:"),N.map((function(e){var a=e.label,t=e.permalink;return n.a.createElement(i.a,{key:t,className:"margin-horiz--sm",to:t},a)}))),g&&n.a.createElement("div",{className:"col text--right"},n.a.createElement(i.a,{to:d.permalink,"aria-label":"Read more about "+O},n.a.createElement("strong",null,"Read More")))))}}}]); \ No newline at end of file diff --git a/d9b8b8b3.80b16e54.js b/d9b8b8b3.15ee97bd.js similarity index 87% rename from d9b8b8b3.80b16e54.js rename to d9b8b8b3.15ee97bd.js index 770f90abf58..2605c71043e 100644 --- a/d9b8b8b3.80b16e54.js +++ b/d9b8b8b3.15ee97bd.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{261:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return i})),n.d(t,"metadata",(function(){return l})),n.d(t,"rightToc",(function(){return p})),n.d(t,"default",(function(){return b}));var r=n(1),a=n(9),o=(n(0),n(296)),i={id:"integrations",title:"Workflow Integrations"},l={id:"integrations",title:"Workflow Integrations",description:"## Workflow Integration (Maven, Github, CI/CD)",source:"@site/../docs/integration.md",permalink:"/docs/integrations",editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/integration.md",lastUpdatedBy:"William Cheng",lastUpdatedAt:1581087531,sidebar:"docs",previous:{title:"Debugging",permalink:"/docs/debugging"},next:{title:"Guidelines For Contributing",permalink:"/docs/contributing"}},p=[{value:"Workflow Integration (Maven, Github, CI/CD)",id:"workflow-integration-maven-github-cicd",children:[{value:"Gradle Integration",id:"gradle-integration",children:[]},{value:"Maven Integration",id:"maven-integration",children:[]},{value:"sbt Integration",id:"sbt-integration",children:[]},{value:"Bazel Integration",id:"bazel-integration",children:[]},{value:"GitHub Integration",id:"github-integration",children:[]},{value:"CI/CD",id:"cicd",children:[]}]}],c={rightToc:p};function b(e){var t=e.components,n=Object(a.a)(e,["components"]);return Object(o.b)("wrapper",Object(r.a)({},c,n,{components:t,mdxType:"MDXLayout"}),Object(o.b)("h2",{id:"workflow-integration-maven-github-cicd"},"Workflow Integration (Maven, Github, CI/CD)"),Object(o.b)("h3",{id:"gradle-integration"},"Gradle Integration"),Object(o.b)("p",null,"See the ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-gradle-plugin/README.adoc"}),"openapi-generator-gradle-plugin README")," for details related to configuring and using the Gradle Plugin."),Object(o.b)("p",null,"Supported tasks include:"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Listing generators"),Object(o.b)("li",{parentName:"ul"},"Validation of Open API 2.0 and 3.0 Specs"),Object(o.b)("li",{parentName:"ul"},'Generating "Meta" generators'),Object(o.b)("li",{parentName:"ul"},"Generating all generators supported by OpenAPI Generator")),Object(o.b)("h3",{id:"maven-integration"},"Maven Integration"),Object(o.b)("p",null,"See the ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator-maven-plugin/README.md"}),"openapi-generator-maven-plugin README")," for details related to configuring and using the Maven Plugin."),Object(o.b)("h3",{id:"sbt-integration"},"sbt Integration"),Object(o.b)("p",null,"Please refer to ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/upstart-commerce/sbt-openapi-generator"}),"https://github.com/upstart-commerce/sbt-openapi-generator")),Object(o.b)("h3",{id:"bazel-integration"},"Bazel Integration"),Object(o.b)("p",null,"Please refer to ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator-bazel"}),"https://github.com/OpenAPITools/openapi-generator-bazel")),Object(o.b)("h3",{id:"github-integration"},"GitHub Integration"),Object(o.b)("p",null,"To push the auto-generated SDK to GitHub, we provide ",Object(o.b)("inlineCode",{parentName:"p"},"git_push.sh")," to streamline the process. For example:"),Object(o.b)("p",null," 1) Create a new repository in GitHub (Ref: ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://help.github.com/articles/creating-a-new-repository/"}),"https://help.github.com/articles/creating-a-new-repository/"),")"),Object(o.b)("p",null," 2) Generate the SDK"),Object(o.b)("pre",null,Object(o.b)("code",Object(r.a)({parentName:"pre"},{className:"language-sh"}),' java -jar openapi-generator-cli.jar generate \\\n -i modules/openapi-generator/src/test/resources/2_0/petstore.json -g perl \\\n --git-user-id "wing328" \\\n --git-repo-id "petstore-perl" \\\n --release-note "Github integration demo" \\\n -o /var/tmp/perl/petstore\n')),Object(o.b)("p",null," 3) Push the SDK to GitHub"),Object(o.b)("pre",null,Object(o.b)("code",Object(r.a)({parentName:"pre"},{className:"language-sh"}),"cd /var/tmp/perl/petstore\n/bin/sh ./git_push.sh\n")),Object(o.b)("h3",{id:"cicd"},"CI/CD"),Object(o.b)("p",null,"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)"),Object(o.b)("p",null,"If you're looking for the configuration files of a particular CI that is not yet supported, please open an ",Object(o.b)("a",Object(r.a)({parentName:"p"},{href:"https://github.com/openapitools/openapi-generator/issues/new"}),"issue")," to let us know."))}b.isMDXComponent=!0},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return u})),n.d(t,"b",(function(){return d}));var r=n(0),a=n.n(r);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);t&&(r=r.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,r)}return n}function l(e){for(var t=1;t=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=a.a.createContext({}),b=function(e){var t=a.a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):l({},t,{},e)),n},u=function(e){var t=b(e.components);return a.a.createElement(c.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},g=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,c=p(e,["components","mdxType","originalType","parentName"]),u=b(n),g=r,d=u["".concat(i,".").concat(g)]||u[g]||s[g]||o;return n?a.a.createElement(d,l({ref:t},c,{components:n})):a.a.createElement(d,l({ref:t},c))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=g;var l={};for(var p in t)hasOwnProperty.call(t,p)&&(l[p]=t[p]);l.originalType=e,l.mdxType="string"==typeof e?e:r,i[1]=l;for(var c=2;c=0||(a[n]=e[n]);return a}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(a[n]=e[n])}return a}var c=a.a.createContext({}),b=function(e){var t=a.a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):p({},t,{},e)),n},u=function(e){var t=b(e.components);return a.a.createElement(c.Provider,{value:t},e.children)},s={inlineCode:"code",wrapper:function(e){var t=e.children;return a.a.createElement(a.a.Fragment,{},t)}},g=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,i=e.parentName,c=l(e,["components","mdxType","originalType","parentName"]),u=b(n),g=r,d=u["".concat(i,".").concat(g)]||u[g]||s[g]||o;return n?a.a.createElement(d,p({ref:t},c,{components:n})):a.a.createElement(d,p({ref:t},c))}));function d(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,i=new Array(o);i[0]=g;var p={};for(var l in t)hasOwnProperty.call(t,l)&&(p[l]=t[l]);p.originalType=e,p.mdxType="string"==typeof e?e:r,i[1]=p;for(var c=2;c - +
-

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, version 1.4, available at http://contributor-covenant.org/version/1/4

Edit this page
Last updated on by William Cheng
+

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, version 1.4, available at http://contributor-covenant.org/version/1/4

Edit this page
Last updated on by Keenan Pepper
- + - + - + - + diff --git a/docs/contribute-building/index.html b/docs/contribute-building/index.html index 8a0f87dcb3c..608b49fc2a6 100644 --- a/docs/contribute-building/index.html +++ b/docs/contribute-building/index.html @@ -21,33 +21,33 @@ - +

Building the code

Using Maven

To build from source, you need the following installed and available in your $PATH:

After cloning the project, you can build it from source with this command:

mvn clean install

If you don't have maven installed, you may directly use the included maven wrapper, and build with the command:

./mvnw clean install

Using Docker

You can use run-in-docker.sh to do all development. This script maps your local repository to /gen -in the docker container. It also maps ~/.m2/repository to the appropriate container location.

To execute mvn package:

git clone https://github.com/openapitools/openapi-generator
cd openapi-generator
./run-in-docker.sh mvn package

Build artifacts are now accessible in your working directory.

Once built, run-in-docker.sh will act as an executable for openapi-generator-cli. To generate code, you'll need to output to a directory under /gen (e.g. /gen/out). For example:

./run-in-docker.sh help # Executes 'help' command for openapi-generator-cli
./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
./run-in-docker.sh /gen/bin/go-petstore.sh  # Builds the Go client
./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
    -g go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore

Docker in Vagrant

Prerequisite: install Vagrant and VirtualBox.

git clone https://github.com/openapitools/openapi-generator.git
cd openapi-generator
vagrant up
vagrant ssh
cd /vagrant
./run-in-docker.sh mvn package

Troubleshooting

If an error like this occurs, just execute the mvn clean install -U command:

org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException

./run-in-docker.sh mvn clean install -U

Failed to execute goal org.fortasoft:gradle-maven-plugin:1.0.8:invoke (default) on project openapi-generator-gradle-plugin-mvn-wrapper: org.gradle.tooling.BuildException: Could not execute build using Gradle distribution 'https://services.gradle.org/distributions/gradle-4.7-bin.zip'

Right now: no solution for this one :|

Edit this page
Last updated on by William Cheng
+in the docker container. It also maps ~/.m2/repository to the appropriate container location.

To execute mvn package:

git clone https://github.com/openapitools/openapi-generator
cd openapi-generator
./run-in-docker.sh mvn package

Build artifacts are now accessible in your working directory.

Once built, run-in-docker.sh will act as an executable for openapi-generator-cli. To generate code, you'll need to output to a directory under /gen (e.g. /gen/out). For example:

./run-in-docker.sh help # Executes 'help' command for openapi-generator-cli
./run-in-docker.sh list # Executes 'list' command for openapi-generator-cli
./run-in-docker.sh /gen/bin/go-petstore.sh  # Builds the Go client
./run-in-docker.sh generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml \
    -g go -o /gen/out/go-petstore -DpackageName=petstore # generates go client, outputs locally to ./out/go-petstore

Docker in Vagrant

Prerequisite: install Vagrant and VirtualBox.

git clone https://github.com/openapitools/openapi-generator.git
cd openapi-generator
vagrant up
vagrant ssh
cd /vagrant
./run-in-docker.sh mvn package

Troubleshooting

If an error like this occurs, just execute the mvn clean install -U command:

org.apache.maven.lifecycle.LifecycleExecutionException: Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test (default-test) on project openapi-generator: A type incompatibility occurred while executing org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test: java.lang.ExceptionInInitializerError cannot be cast to java.io.IOException

./run-in-docker.sh mvn clean install -U

Failed to execute goal org.fortasoft:gradle-maven-plugin:1.0.8:invoke (default) on project openapi-generator-gradle-plugin-mvn-wrapper: org.gradle.tooling.BuildException: Could not execute build using Gradle distribution 'https://services.gradle.org/distributions/gradle-4.7-bin.zip'

Right now: no solution for this one :|

Edit this page
Last updated on by Keenan Pepper
- + - + - + - + diff --git a/docs/contributing/index.html b/docs/contributing/index.html index 4e286d9e94a..65403876382 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -21,33 +21,33 @@ - +

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
  • Search the open issue and closed issue to ensure no one else has reported something similar before.
  • File an issue ticket 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 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" 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 page for more information.

Code generators

All the code generators can be found in modules/openapi-generator/src/main/java/org/openapitools/codegen/languages

If you want to add a new generator, follow the new-generator guide.

Templates

All the templates (mustache) can be found in modules/openapi-generator/src/main/resources.

For a list of variables available in the template, please refer to this page

Style guide

Code change should conform to the programming style guide of the respective languages:

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, 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

To test the templates, please perform the following:

  • Update the Petstore sample by running the shell scripts under bin and bin/openapi3 folder. For example, run ./bin/python-petstore.sh and ./bin/openapi3/python-petstore.sh to update the Python PetStore API client under samples/client/petstore/python and samples/openapi3/client/petstore/python. 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 using maven mvn integration-test -rf :<artifactId>, e.g. open a shell in samples/client/petstore/python, run mvn integration-test -rf :PythonPetstoreClientTests. The artifactId of the project can be found in the pom.xml file. (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

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 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)
Edit this page
Last updated on by William Cheng
+(git add -A if added files with new test cases)
  • For new test cases, please add to the Fake Petstore spec

    • 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 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)
    Edit this page
    Last updated on by Keenan Pepper
    - + - + - + - + diff --git a/docs/core-team/index.html b/docs/core-team/index.html index 14680840ae5..cf206b31551 100644 --- a/docs/core-team/index.html +++ b/docs/core-team/index.html @@ -21,32 +21,32 @@ - +
    -
    Edit this page
    Last updated on by William Cheng
    +
    Edit this page
    Last updated on by Keenan Pepper
    - + - + - + - + diff --git a/docs/customization/index.html b/docs/customization/index.html index 7e2ee68c464..f9899828f55 100644 --- a/docs/customization/index.html +++ b/docs/customization/index.html @@ -21,7 +21,7 @@ - + @@ -32,20 +32,20 @@ These options default to true and don't limit the generation of the feature These options are applied via configuration file (e.g. config.json or config.yml) or by passing them with -p {optionName}={optionValue}. (If -p {optionName} does not work, please open a ticket and we'll look into it)

    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -g java

    Output

    CONFIG OPTIONS
        modelPackage
            package for generated models
        apiPackage
            package for generated api classes
    ...... (results omitted)
        library
            library template (sub-template) to use:
            jersey1 - HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2
            jersey2 - HTTP client: Jersey client 2.6
            feign - HTTP client: Netflix Feign 8.1.1.  JSON processing: Jackson 2.6.3
            okhttp-gson (default) - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1
            retrofit - HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)
            retrofit2 - HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)
            google-api-client - HTTP client: google-api-client 1.23.0. JSON processing: Jackson 2.8.9
            rest-assured - HTTP client: rest-assured : 4.0.0. JSON processing: Gson 2.8.5. Only for Java8

    Your config file for Java can look like

    {
      "groupId":"com.my.company",
      "artifactId":"MyClient",
      "artifactVersion":"1.2.0",
      "library":"feign"
    }

    Or if you preffer yaml format it can look like

    groupId: "com.my.company"
    artifactId: "MyClient"
    artifactVersion: "1.2.0"
    library: "feign"

    For all the unspecified options default values will be used.

    Another way to override default options is to extend the config class for the specific language. To change, for example, the prefix for the Objective-C generated files, simply subclass the ObjcClientCodegen.java:

    package com.mycompany.openapitools.codegen;
    import org.openapitools.codegen.languages.*;
    public class MyObjcCodegen extends ObjcClientCodegen {
        static {
            PREFIX = "HELO";
        }
    }

    and specify the classname when running the generator:

    -g com.mycompany.openapitools.codegen.MyObjcCodegen

    Your subclass will now be loaded and overrides the PREFIX value in the superclass.

    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 -refer back to your classes. Note, this may not apply to all languages...

    To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:

    --import-mappings Pet=my.models.MyPet

    Or for multiple mappings:

    --import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder

    or

    --import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder
    Edit this page
    Last updated on by Jim Schubert
    +refer back to your classes. Note, this may not apply to all languages...

    To specify an import mapping, use the --import-mappings argument and specify the model-to-import logic as such:

    --import-mappings Pet=my.models.MyPet

    Or for multiple mappings:

    --import-mappings Pet=my.models.MyPet,Order=my.models.MyOrder

    or

    --import-mappings Pet=my.models.MyPet --import-mappings Order=my.models.MyOrder
    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/debugging/index.html b/docs/debugging/index.html index 901735b29f5..ec4bd1df238 100644 --- a/docs/debugging/index.html +++ b/docs/debugging/index.html @@ -21,32 +21,32 @@ - +
    -

    Debugging

    Templates

    Sometimes, you may have issues with variables in your templates. As discussed in the templating docs, we offer a variety of system properties for inspecting the models bound to templates.

    -DdebugOpenAPI
    Prints out the JSON model of the OpenAPI Document, as seen by OpenAPI Generator
    -DdebugModels
    Prints out the JSON model passed to model templates
    -DdebugOperations
    Prints out the JSON model passed to operation (api) templates
    -DdebugSupportingFiles
    Prints out the JSON model passed to supporting files

    One or more of these properties can be passed alongside other command line options:

    openapi-generator generate -g go \
        -o out \
        -i petstore-minimal.yaml \
        -DdebugModels \
        -DdebugOperations

    Or you can add these to your JAVA_OPTS environment variable (this applies to every invocation of the tool):

    export JAVA_OPTS="${JAVA_OPTS} -DdebugModels -DdebugOperations"

    NOTE: Globally available system options like these will apply to all invocations of the generator (CLI and plugins)

    Runtime

    When you're working with a custom generator, a new generator, or otherwise trying to understand the behavior of the toolset, you may need to attach a remote debugger in order to step through the code.

    The steps are shown here for a specific version of the generator, but apply the same if you're working off master or a feature branch.

    • Determine the version of openapi-generator you're using. For the CLI, this is: 
      openapi-generator version
    • Navigate to the openapi-generator source directory (see building docs for obtaining source code and brief introduction).
    • Checkout the branch/tag for the target version. Branches are not prefixed, but tags are prefixed with a v. For instance if you're using version 3.3.0, you will execute:
      git checkout v3.3.0
    • Open the project in your IDE.
    • Setup your IDE for remote debugging. You'll want to define a port used for connecting the remote debugger. For this example, we'll use 5005. See external tutorials for IntelliJ and Eclipse
    • Export the debug configuration, specifying suspend=y so you have time to attach a remote debugger. These are passed as Java system properties, either on command line or as part of the JAVA_OPTS environment variable. This will look like:
      export JAVA_OPTS="${JAVA_OPTS} -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"
    • Execute the generator with your desired options. You should see the application output only
      Listening for transport dt_socket at address: 5005
    • Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.

    Logs

    You can try to enable debugging log with -Dlog.level=debug option to the JAVA_OPTS environment variable to see more information:

    export JAVA_OPTS="${JAVA_OPTS} -Dlog.level=debug"

    Set the option then DEBUG logs are printed out:

    openapi-generator generate -g go ...
    ...
    ...
    [main] DEBUG o.o.codegen.DefaultCodegen - debugging fromProperty for files : class Schema {
        type: null
        format: null
        $ref: #/components/schemas/File
    ...
    ...
    Edit this page
    Last updated on by William Cheng
    +

    Debugging

    Templates

    Sometimes, you may have issues with variables in your templates. As discussed in the templating docs, we offer a variety of system properties for inspecting the models bound to templates.

    -DdebugOpenAPI
    Prints out the JSON model of the OpenAPI Document, as seen by OpenAPI Generator
    -DdebugModels
    Prints out the JSON model passed to model templates
    -DdebugOperations
    Prints out the JSON model passed to operation (api) templates
    -DdebugSupportingFiles
    Prints out the JSON model passed to supporting files

    One or more of these properties can be passed alongside other command line options:

    openapi-generator generate -g go \
        -o out \
        -i petstore-minimal.yaml \
        -DdebugModels \
        -DdebugOperations

    Or you can add these to your JAVA_OPTS environment variable (this applies to every invocation of the tool):

    export JAVA_OPTS="${JAVA_OPTS} -DdebugModels -DdebugOperations"

    NOTE: Globally available system options like these will apply to all invocations of the generator (CLI and plugins)

    Runtime

    When you're working with a custom generator, a new generator, or otherwise trying to understand the behavior of the toolset, you may need to attach a remote debugger in order to step through the code.

    The steps are shown here for a specific version of the generator, but apply the same if you're working off master or a feature branch.

    • Determine the version of openapi-generator you're using. For the CLI, this is: 
      openapi-generator version
    • Navigate to the openapi-generator source directory (see building docs for obtaining source code and brief introduction).
    • Checkout the branch/tag for the target version. Branches are not prefixed, but tags are prefixed with a v. For instance if you're using version 3.3.0, you will execute:
      git checkout v3.3.0
    • Open the project in your IDE.
    • Setup your IDE for remote debugging. You'll want to define a port used for connecting the remote debugger. For this example, we'll use 5005. See external tutorials for IntelliJ and Eclipse
    • Export the debug configuration, specifying suspend=y so you have time to attach a remote debugger. These are passed as Java system properties, either on command line or as part of the JAVA_OPTS environment variable. This will look like:
      export JAVA_OPTS="${JAVA_OPTS} -agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"
    • Execute the generator with your desired options. You should see the application output only
      Listening for transport dt_socket at address: 5005
    • Set breakpoints in code, and then attach your remote debugger from your IDE (see above). The generator will automatically unblock once the remote debugger is attached. You can now step through the code.

    Logs

    You can try to enable debugging log with -Dlog.level=debug option to the JAVA_OPTS environment variable to see more information:

    export JAVA_OPTS="${JAVA_OPTS} -Dlog.level=debug"

    Set the option then DEBUG logs are printed out:

    openapi-generator generate -g go ...
    ...
    ...
    [main] DEBUG o.o.codegen.DefaultCodegen - debugging fromProperty for files : class Schema {
        type: null
        format: null
        $ref: #/components/schemas/File
    ...
    ...
    Edit this page
    Last updated on by Keenan Pepper
    - + - + - + - + diff --git a/docs/faq-contributing/index.html b/docs/faq-contributing/index.html index 841b49679d8..5eb1af8041c 100644 --- a/docs/faq-contributing/index.html +++ b/docs/faq-contributing/index.html @@ -21,7 +21,7 @@ - + @@ -33,20 +33,20 @@ 4) make changes 5) git commit -a (you may need to use git add filename to add new files) 6) git push origin fix_issue9999 -7) Visit https://github.com/openapitools/openapi-generator in your browser and click on the button to file a new PR based on fix_issue9999

    Edit this page
    Last updated on by Jim Schubert
    +7) Visit https://github.com/openapitools/openapi-generator in your browser and click on the button to file a new PR based on fix_issue9999

    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/faq-extending/index.html b/docs/faq-extending/index.html index 0125d31914c..21b6ab5e74f 100644 --- a/docs/faq-extending/index.html +++ b/docs/faq-extending/index.html @@ -21,26 +21,26 @@ - +
    -

    FAQ: Extending

    How do I use my own Java models?

    See Bringing your own Models.

    How do I disable certificate verification?

    Please add -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true when generating the code.

    How do I skip files during code generation?

    OpenAPI Generator has a built-in ignore file processor.

    For example, to skip git_push.sh, one can create a file named .openapi-generator-ignore in the root of the output directory with the contents:

    # Prevent generator from creating these files:
    git_push.sh

    The ignore file works just like .gitignore, and it is auto-generated by default.

    If you need this functionality on initial generation, you can provide the option --ignore-file-override (CLI) or ignoreFileOverride (Maven and Gradle plugins) with a value targeting any existing file. The contents of that file will be evaluated relative to the output directory.

    How can I customize the auto-generated code?

    Variants:

    • "How can I add a header/footer to generated code?"
    • "How can I add my own logging to generated code?"
    • "How can I add my license to the top of files?"

    OpenAPI Generator supports user-defined templates without need to recompile the artifact. We also support custom generators (templates and logic) if those generators are accessible on the classpath.

    See templating: Modifying Templates and customization docs for more details.

    Edit this page
    Last updated on by Jim Schubert
    +

    FAQ: Extending

    How do I use my own Java models?

    See Bringing your own Models.

    How do I disable certificate verification?

    Please add -Dio.swagger.v3.parser.util.RemoteUrl.trustAll=true when generating the code.

    How do I skip files during code generation?

    OpenAPI Generator has a built-in ignore file processor.

    For example, to skip git_push.sh, one can create a file named .openapi-generator-ignore in the root of the output directory with the contents:

    # Prevent generator from creating these files:
    git_push.sh

    The ignore file works just like .gitignore, and it is auto-generated by default.

    If you need this functionality on initial generation, you can provide the option --ignore-file-override (CLI) or ignoreFileOverride (Maven and Gradle plugins) with a value targeting any existing file. The contents of that file will be evaluated relative to the output directory.

    How can I customize the auto-generated code?

    Variants:

    • "How can I add a header/footer to generated code?"
    • "How can I add my own logging to generated code?"
    • "How can I add my license to the top of files?"

    OpenAPI Generator supports user-defined templates without need to recompile the artifact. We also support custom generators (templates and logic) if those generators are accessible on the classpath.

    See templating: Modifying Templates and customization docs for more details.

    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/faq-generators/index.html b/docs/faq-generators/index.html index 6d8df0c4871..953087093f1 100644 --- a/docs/faq-generators/index.html +++ b/docs/faq-generators/index.html @@ -21,26 +21,26 @@ - +
    -

    FAQ: Generators

    What are some server generator use cases?

    We have around 40+ server generators, with more added regularly. Some of these include Spring in your choice of Java or Kotlin, the Finch and Scalatra frameworks using Scala, and C# generators for NancyFX and WebAPI (to name only a few).

    Besides generating the server code as a starting point to implement the API backend, here are some use cases of the server generators:

    • prototyping - one can generate the server code and have a functional API backend very quickly to try different things or features.
    • mocking - easily provide an API backend for mocking based on the examples field defined in the response object.
    • migration - let's say one wants to migrate an API backend from Ruby on Rails to Java Spring. The server generator can save a lot of time in implementing and verify each endpoint in the new API backend.
    • evaluating - when you want to try a new language or framework, and a typical "Hello, World" is too trivial.

    Java

    The API client has SSL errors due to an invalid certificate. Is there a way to bypass that?

    Yes, please refer to http://stackoverflow.com/a/6055903/677735

    How can I customize the Feign client templates?

    You will need to provide customized files in Java/libraries/feign under the resources folder and pass the location via the -t option.

    In your Gradle build script, please add the following (example):

    config.templateDir = 'src/openapi-generator-templates/Java/libraries/feign

    Android

    How can I generate an Android SDK?

    The Java SDK is also compatible with Android.

    [RECOMMENDED] To generate the Java SDK with okhttp and gson libraries, run the following:

    mvn clean package
    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
      -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.json \
      -l java --library=okhttp-gson \
      -D hideGenerationTimestamp=true \
      -o /var/tmp/java/okhttp-gson/

    You can also generate the Java SDK with other HTTP libraries by replacing okhttp-gson with retrofit for example. For a list of support libraries, please run

    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -l java

    To generate the Android SDK with volley, please run

    mvn clean package
    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
      -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.json \
      -l android --library=volley \
      -o /var/tmp/android/volley/

    We do not recommend using the default HTTP library (Apache HttpClient) with android as it's not actively maintained.

    C-Sharp

    How do I fix CSC: warning CS2002 in Xamarin?

    The full warning might look like this: CSC: warning CS2002: Source file 'Api/FakeApi.cs' specified multiple times

    The warning has no impact on the build process so you should be able to build the solution without issue. The warning should be addressed in the upcoming stable release of Xamarin.

    Objective-C

    How do I run integration test with Petstore ObjC API client?

    Here are the steps:

    git clone https://github.com/openapitools/openapi-generator.git
    cd openapi-generator/samples/client/petstore/objc/default/OpenAPIClientTests
    mvn integration-test

    Besides default (folder) ObjC API client, there's also core-data for another ObjC API client with Core Data support.

    Swift

    How do I run integration test with Petstore Swift API client?

    Here are the steps:

    git clone https://github.com/openapitools/openapi-generator.git
    cd openapi-generator/samples/client/petstore/swift/default/OpenAPIClientTests
    mvn integration-test

    Besides default (folder), there's another folder promisekit for Swift API client with PromiseKit support

    git clone https://github.com/openapitools/openapi-generator.git
    cd openapi-generator/samples/client/petstore/swift/promisekit/OpenAPIClientTests
    mvn integration-test

    Is Swift (2.x) generator still actively maintained?

    No, please use swift3 or swift4 generator instead as we want to focus on Swift 3.x, 4.x.

    TypeScript

    The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?

    Yes, please use the following option when generating TypeScript clients:

    modelPropertyNaming
            Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
    Edit this page
    Last updated on by Jim Schubert
    +

    FAQ: Generators

    What are some server generator use cases?

    We have around 40+ server generators, with more added regularly. Some of these include Spring in your choice of Java or Kotlin, the Finch and Scalatra frameworks using Scala, and C# generators for NancyFX and WebAPI (to name only a few).

    Besides generating the server code as a starting point to implement the API backend, here are some use cases of the server generators:

    • prototyping - one can generate the server code and have a functional API backend very quickly to try different things or features.
    • mocking - easily provide an API backend for mocking based on the examples field defined in the response object.
    • migration - let's say one wants to migrate an API backend from Ruby on Rails to Java Spring. The server generator can save a lot of time in implementing and verify each endpoint in the new API backend.
    • evaluating - when you want to try a new language or framework, and a typical "Hello, World" is too trivial.

    Java

    The API client has SSL errors due to an invalid certificate. Is there a way to bypass that?

    Yes, please refer to http://stackoverflow.com/a/6055903/677735

    How can I customize the Feign client templates?

    You will need to provide customized files in Java/libraries/feign under the resources folder and pass the location via the -t option.

    In your Gradle build script, please add the following (example):

    config.templateDir = 'src/openapi-generator-templates/Java/libraries/feign

    Android

    How can I generate an Android SDK?

    The Java SDK is also compatible with Android.

    [RECOMMENDED] To generate the Java SDK with okhttp and gson libraries, run the following:

    mvn clean package
    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
      -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.json \
      -l java --library=okhttp-gson \
      -D hideGenerationTimestamp=true \
      -o /var/tmp/java/okhttp-gson/

    You can also generate the Java SDK with other HTTP libraries by replacing okhttp-gson with retrofit for example. For a list of support libraries, please run

    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar config-help -l java

    To generate the Android SDK with volley, please run

    mvn clean package
    java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
      -i https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.json \
      -l android --library=volley \
      -o /var/tmp/android/volley/

    We do not recommend using the default HTTP library (Apache HttpClient) with android as it's not actively maintained.

    C-Sharp

    How do I fix CSC: warning CS2002 in Xamarin?

    The full warning might look like this: CSC: warning CS2002: Source file 'Api/FakeApi.cs' specified multiple times

    The warning has no impact on the build process so you should be able to build the solution without issue. The warning should be addressed in the upcoming stable release of Xamarin.

    Objective-C

    How do I run integration test with Petstore ObjC API client?

    Here are the steps:

    git clone https://github.com/openapitools/openapi-generator.git
    cd openapi-generator/samples/client/petstore/objc/default/OpenAPIClientTests
    mvn integration-test

    Besides default (folder) ObjC API client, there's also core-data for another ObjC API client with Core Data support.

    Swift

    How do I run integration test with Petstore Swift API client?

    Here are the steps:

    git clone https://github.com/openapitools/openapi-generator.git
    cd openapi-generator/samples/client/petstore/swift/default/OpenAPIClientTests
    mvn integration-test

    Besides default (folder), there's another folder promisekit for Swift API client with PromiseKit support

    git clone https://github.com/openapitools/openapi-generator.git
    cd openapi-generator/samples/client/petstore/swift/promisekit/OpenAPIClientTests
    mvn integration-test

    Is Swift (2.x) generator still actively maintained?

    No, please use swift3 or swift4 generator instead as we want to focus on Swift 3.x, 4.x.

    TypeScript

    The JSON response fails to deserialize due to change in variable naming (snake_case to camelCase). Is there any way to keep the original naming?

    Yes, please use the following option when generating TypeScript clients:

    modelPropertyNaming
            Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name (Default: camelCase)
    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/faq/index.html b/docs/faq/index.html index 681dd5047f7..f176855e68e 100644 --- a/docs/faq/index.html +++ b/docs/faq/index.html @@ -21,26 +21,26 @@ - +
    -

    FAQ: General

    Do you have a chat room?

    Jion the Slack chat room

    What is the governance structure of the OpenAPI Generator project?

    OpenAPI generator (openapi-generator) is managed by the members of the 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. For more details, see the Fork Q&A.

    Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.

    Edit this page
    Last updated on by Jim Schubert
    +

    FAQ: General

    Do you have a chat room?

    Jion the Slack chat room

    What is the governance structure of the OpenAPI Generator project?

    OpenAPI generator (openapi-generator) is managed by the members of the 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. For more details, see the Fork Q&A.

    Swagger is a trademark owned by SmartBear and the use of the term "Swagger" in this project is for demo (reference) purposes only.

    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/fork-qna/index.html b/docs/fork-qna/index.html index 4df4e5e4618..75c3aa6b3ab 100644 --- a/docs/fork-qna/index.html +++ b/docs/fork-qna/index.html @@ -21,26 +21,26 @@ - +
    -

    Swagger Codegen Fork: Q&A

    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.

    Why was it decided to fork Swagger Codegen?

    There are several reasons:

    1. The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x.
    2. 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.
    3. The founding members wanted a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
    4. Having a community-driven version allows for innovation, reliability, and a roadmap owned by the community.

    Are there any changes to the project license?

    No, OpenAPI Generator is still using the Apache license (version 2).

    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 for more information.

    Who maintains this Q&A page?

    This Q&A page is maintained by the core team members. It is not maintained by any single person, nor do these Q&As represent the views of any individual or person.

    Edit this page
    Last updated on by Jim Schubert
    +

    Swagger Codegen Fork: Q&A

    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.

    Why was it decided to fork Swagger Codegen?

    There are several reasons:

    1. The founding members felt that Swagger Codegen 3.0.0 was diverging too much from the philosophy of Swagger Codegen 2.x.
    2. 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.
    3. The founding members wanted a more rapid release cycle (weekly patch release, monthly minor release) so users do not need to wait for several months to get a stable release.
    4. Having a community-driven version allows for innovation, reliability, and a roadmap owned by the community.

    Are there any changes to the project license?

    No, OpenAPI Generator is still using the Apache license (version 2).

    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 for more information.

    Who maintains this Q&A page?

    This Q&A page is maintained by the core team members. It is not maintained by any single person, nor do these Q&As represent the views of any individual or person.

    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/generators/README/index.html b/docs/generators/README/index.html index 2ace05ba258..1fbafc1c9d9 100644 --- a/docs/generators/README/index.html +++ b/docs/generators/README/index.html @@ -21,32 +21,32 @@ - +
    -

    README

    The following generators are available:

    CLIENT generators

    SERVER generators

    DOCUMENTATION generators

    SCHEMA generators

    CONFIG generators

    Edit this page
    Last updated on by William Cheng
    +

    README

    The following generators are available:

    CLIENT generators

    SERVER generators

    DOCUMENTATION generators

    SCHEMA generators

    CONFIG generators

    Edit this page
    Last updated on by Keenan Pepper
    - + - + - + - + diff --git a/docs/generators/ada-server/index.html b/docs/generators/ada-server/index.html index 2bbf23b694d..a61fdcf5746 100644 --- a/docs/generators/ada-server/index.html +++ b/docs/generators/ada-server/index.html @@ -21,26 +21,26 @@ - +
    -

    Config Options for ada-server

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    projectNameGNAT project namedefaultProject
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

    IMPORT MAPPING

    Type/AliasImports

    INSTANTIATION TYPES

    Type/AliasInstantiated By

    LANGUAGE PRIMITIVES

    • Boolean
    • Character
    • Integer
    • boolean
    • double
    • float
    • integer
    • long

    RESERVED WORDS

    • abort
    • abs
    • abstract
    • accept
    • access
    • aliased
    • all
    • and
    • array
    • at
    • begin
    • body
    • case
    • constant
    • declare
    • delay
    • digits
    • do
    • else
    • elsif
    • end
    • entry
    • exception
    • exit
    • for
    • function
    • generic
    • goto
    • if
    • in
    • interface
    • is
    • limited
    • loop
    • mod
    • new
    • not
    • null
    • of
    • or
    • others
    • out
    • overriding
    • package
    • pragma
    • private
    • procedure
    • protected
    • raise
    • range
    • record
    • rem
    • renames
    • requeue
    • return
    • reverse
    • select
    • separate
    • some
    • subtype
    • synchronized
    • tagged
    • task
    • terminate
    • then
    • type
    • until
    • use
    • when
    • while
    • with
    • xor

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePath✓ToolingExtension
    Authorizations✗ToolingExtension
    UserAgent✗ToolingExtension

    Data Type Feature

    NameSupportedDefined By
    Custom✗OAS2,OAS3
    Int32✓OAS2,OAS3
    Int64✓OAS2,OAS3
    Float✓OAS2,OAS3
    Double✓OAS2,OAS3
    Decimal✓ToolingExtension
    String✓OAS2,OAS3
    Byte✓OAS2,OAS3
    Binary✓OAS2,OAS3
    Boolean✓OAS2,OAS3
    Date✓OAS2,OAS3
    DateTime✓OAS2,OAS3
    Password✓OAS2,OAS3
    File✓OAS2
    Array✓OAS2,OAS3
    Maps✓ToolingExtension
    CollectionFormat✓OAS2
    CollectionFormatMulti✓OAS2
    Enum✓OAS2,OAS3
    ArrayOfEnum✓ToolingExtension
    ArrayOfModel✓ToolingExtension
    ArrayOfCollectionOfPrimitives✓ToolingExtension
    ArrayOfCollectionOfModel✓ToolingExtension
    ArrayOfCollectionOfEnum✓ToolingExtension
    MapOfEnum✓ToolingExtension
    MapOfModel✓ToolingExtension
    MapOfCollectionOfPrimitives✓ToolingExtension
    MapOfCollectionOfModel✓ToolingExtension
    MapOfCollectionOfEnum✓ToolingExtension

    Documentation Feature

    NameSupportedDefined By
    Readme✓ToolingExtension
    Model✓ToolingExtension
    Api✓ToolingExtension

    Global Feature

    NameSupportedDefined By
    Host✓OAS2,OAS3
    BasePath✓OAS2,OAS3
    Info✓OAS2,OAS3
    Schemes✗OAS2,OAS3
    PartialSchemes✓OAS2,OAS3
    Consumes✓OAS2
    Produces✓OAS2
    ExternalDocumentation✓OAS2,OAS3
    Examples✓OAS2,OAS3
    XMLStructureDefinitions✗OAS2,OAS3
    MultiServer✗OAS3
    ParameterizedServer✗OAS3
    ParameterStyling✗OAS3
    Callbacks✗OAS3
    LinkObjects✗OAS3

    Parameter Feature

    NameSupportedDefined By
    Path✓OAS2,OAS3
    Query✓OAS2,OAS3
    Header✗OAS2,OAS3
    Body✓OAS2
    FormUnencoded✓OAS2
    FormMultipart✓OAS2
    Cookie✗OAS3

    Schema Support Feature

    NameSupportedDefined By
    Simple✓OAS2,OAS3
    Composite✓OAS2,OAS3
    Polymorphism✗OAS2,OAS3
    Union✗OAS3

    Security Feature

    NameSupportedDefined By
    BasicAuth✓OAS2,OAS3
    ApiKey✓OAS2,OAS3
    OpenIDConnect✗OAS3
    BearerToken✗OAS3
    OAuth2_Implicit✗OAS2,OAS3
    OAuth2_Password✗OAS2,OAS3
    OAuth2_ClientCredentials✗OAS2,OAS3
    OAuth2_AuthorizationCode✗OAS2,OAS3

    Wire Format Feature

    NameSupportedDefined By
    JSON✓OAS2,OAS3
    XML✗OAS2,OAS3
    PROTOBUF✗ToolingExtension
    Custom✗OAS2,OAS3
    Edit this page
    Last updated on by Jim Schubert
    +

    Config Options for ada-server

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    projectNameGNAT project namedefaultProject
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

    IMPORT MAPPING

    Type/AliasImports

    INSTANTIATION TYPES

    Type/AliasInstantiated By

    LANGUAGE PRIMITIVES

    • Boolean
    • Character
    • Integer
    • boolean
    • double
    • float
    • integer
    • long

    RESERVED WORDS

    • abort
    • abs
    • abstract
    • accept
    • access
    • aliased
    • all
    • and
    • array
    • at
    • begin
    • body
    • case
    • constant
    • declare
    • delay
    • digits
    • do
    • else
    • elsif
    • end
    • entry
    • exception
    • exit
    • for
    • function
    • generic
    • goto
    • if
    • in
    • interface
    • is
    • limited
    • loop
    • mod
    • new
    • not
    • null
    • of
    • or
    • others
    • out
    • overriding
    • package
    • pragma
    • private
    • procedure
    • protected
    • raise
    • range
    • record
    • rem
    • renames
    • requeue
    • return
    • reverse
    • select
    • separate
    • some
    • subtype
    • synchronized
    • tagged
    • task
    • terminate
    • then
    • type
    • until
    • use
    • when
    • while
    • with
    • xor

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePath✓ToolingExtension
    Authorizations✗ToolingExtension
    UserAgent✗ToolingExtension

    Data Type Feature

    NameSupportedDefined By
    Custom✗OAS2,OAS3
    Int32✓OAS2,OAS3
    Int64✓OAS2,OAS3
    Float✓OAS2,OAS3
    Double✓OAS2,OAS3
    Decimal✓ToolingExtension
    String✓OAS2,OAS3
    Byte✓OAS2,OAS3
    Binary✓OAS2,OAS3
    Boolean✓OAS2,OAS3
    Date✓OAS2,OAS3
    DateTime✓OAS2,OAS3
    Password✓OAS2,OAS3
    File✓OAS2
    Array✓OAS2,OAS3
    Maps✓ToolingExtension
    CollectionFormat✓OAS2
    CollectionFormatMulti✓OAS2
    Enum✓OAS2,OAS3
    ArrayOfEnum✓ToolingExtension
    ArrayOfModel✓ToolingExtension
    ArrayOfCollectionOfPrimitives✓ToolingExtension
    ArrayOfCollectionOfModel✓ToolingExtension
    ArrayOfCollectionOfEnum✓ToolingExtension
    MapOfEnum✓ToolingExtension
    MapOfModel✓ToolingExtension
    MapOfCollectionOfPrimitives✓ToolingExtension
    MapOfCollectionOfModel✓ToolingExtension
    MapOfCollectionOfEnum✓ToolingExtension

    Documentation Feature

    NameSupportedDefined By
    Readme✓ToolingExtension
    Model✓ToolingExtension
    Api✓ToolingExtension

    Global Feature

    NameSupportedDefined By
    Host✓OAS2,OAS3
    BasePath✓OAS2,OAS3
    Info✓OAS2,OAS3
    Schemes✗OAS2,OAS3
    PartialSchemes✓OAS2,OAS3
    Consumes✓OAS2
    Produces✓OAS2
    ExternalDocumentation✓OAS2,OAS3
    Examples✓OAS2,OAS3
    XMLStructureDefinitions✗OAS2,OAS3
    MultiServer✗OAS3
    ParameterizedServer✗OAS3
    ParameterStyling✗OAS3
    Callbacks✗OAS3
    LinkObjects✗OAS3

    Parameter Feature

    NameSupportedDefined By
    Path✓OAS2,OAS3
    Query✓OAS2,OAS3
    Header✗OAS2,OAS3
    Body✓OAS2
    FormUnencoded✓OAS2
    FormMultipart✓OAS2
    Cookie✗OAS3

    Schema Support Feature

    NameSupportedDefined By
    Simple✓OAS2,OAS3
    Composite✓OAS2,OAS3
    Polymorphism✗OAS2,OAS3
    Union✗OAS3

    Security Feature

    NameSupportedDefined By
    BasicAuth✓OAS2,OAS3
    ApiKey✓OAS2,OAS3
    OpenIDConnect✗OAS3
    BearerToken✗OAS3
    OAuth2_Implicit✗OAS2,OAS3
    OAuth2_Password✗OAS2,OAS3
    OAuth2_ClientCredentials✗OAS2,OAS3
    OAuth2_AuthorizationCode✗OAS2,OAS3

    Wire Format Feature

    NameSupportedDefined By
    JSON✓OAS2,OAS3
    XML✗OAS2,OAS3
    PROTOBUF✗ToolingExtension
    Custom✗OAS2,OAS3
    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/generators/ada/index.html b/docs/generators/ada/index.html index 650126f5a52..3278dbd2867 100644 --- a/docs/generators/ada/index.html +++ b/docs/generators/ada/index.html @@ -21,26 +21,26 @@ - +
    -

    Config Options for ada

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    projectNameGNAT project namedefaultProject
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

    IMPORT MAPPING

    Type/AliasImports

    INSTANTIATION TYPES

    Type/AliasInstantiated By

    LANGUAGE PRIMITIVES

    • Boolean
    • Character
    • Integer
    • boolean
    • double
    • float
    • integer
    • long

    RESERVED WORDS

    • abort
    • abs
    • abstract
    • accept
    • access
    • aliased
    • all
    • and
    • array
    • at
    • begin
    • body
    • case
    • constant
    • declare
    • delay
    • digits
    • do
    • else
    • elsif
    • end
    • entry
    • exception
    • exit
    • for
    • function
    • generic
    • goto
    • if
    • in
    • interface
    • is
    • limited
    • loop
    • mod
    • new
    • not
    • null
    • of
    • or
    • others
    • out
    • overriding
    • package
    • pragma
    • private
    • procedure
    • protected
    • raise
    • range
    • record
    • rem
    • renames
    • requeue
    • return
    • reverse
    • select
    • separate
    • some
    • subtype
    • synchronized
    • tagged
    • task
    • terminate
    • then
    • type
    • until
    • use
    • when
    • while
    • with
    • xor

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePath✗ToolingExtension
    Authorizations✗ToolingExtension
    UserAgent✗ToolingExtension

    Data Type Feature

    NameSupportedDefined By
    Custom✗OAS2,OAS3
    Int32✓OAS2,OAS3
    Int64✓OAS2,OAS3
    Float✓OAS2,OAS3
    Double✓OAS2,OAS3
    Decimal✓ToolingExtension
    String✓OAS2,OAS3
    Byte✓OAS2,OAS3
    Binary✓OAS2,OAS3
    Boolean✓OAS2,OAS3
    Date✓OAS2,OAS3
    DateTime✓OAS2,OAS3
    Password✓OAS2,OAS3
    File✓OAS2
    Array✓OAS2,OAS3
    Maps✓ToolingExtension
    CollectionFormat✓OAS2
    CollectionFormatMulti✓OAS2
    Enum✓OAS2,OAS3
    ArrayOfEnum✓ToolingExtension
    ArrayOfModel✓ToolingExtension
    ArrayOfCollectionOfPrimitives✓ToolingExtension
    ArrayOfCollectionOfModel✓ToolingExtension
    ArrayOfCollectionOfEnum✓ToolingExtension
    MapOfEnum✓ToolingExtension
    MapOfModel✓ToolingExtension
    MapOfCollectionOfPrimitives✓ToolingExtension
    MapOfCollectionOfModel✓ToolingExtension
    MapOfCollectionOfEnum✓ToolingExtension

    Documentation Feature

    NameSupportedDefined By
    Readme✗ToolingExtension
    Model✓ToolingExtension
    Api✓ToolingExtension

    Global Feature

    NameSupportedDefined By
    Host✓OAS2,OAS3
    BasePath✓OAS2,OAS3
    Info✓OAS2,OAS3
    Schemes✗OAS2,OAS3
    PartialSchemes✓OAS2,OAS3
    Consumes✓OAS2
    Produces✓OAS2
    ExternalDocumentation✓OAS2,OAS3
    Examples✓OAS2,OAS3
    XMLStructureDefinitions✗OAS2,OAS3
    MultiServer✗OAS3
    ParameterizedServer✗OAS3
    ParameterStyling✗OAS3
    Callbacks✓OAS3
    LinkObjects✗OAS3

    Parameter Feature

    NameSupportedDefined By
    Path✓OAS2,OAS3
    Query✓OAS2,OAS3
    Header✓OAS2,OAS3
    Body✓OAS2
    FormUnencoded✓OAS2
    FormMultipart✓OAS2
    Cookie✓OAS3

    Schema Support Feature

    NameSupportedDefined By
    Simple✓OAS2,OAS3
    Composite✓OAS2,OAS3
    Polymorphism✓OAS2,OAS3
    Union✗OAS3

    Security Feature

    NameSupportedDefined By
    BasicAuth✓OAS2,OAS3
    ApiKey✓OAS2,OAS3
    OpenIDConnect✗OAS3
    BearerToken✓OAS3
    OAuth2_Implicit✓OAS2,OAS3
    OAuth2_Password✓OAS2,OAS3
    OAuth2_ClientCredentials✓OAS2,OAS3
    OAuth2_AuthorizationCode✓OAS2,OAS3

    Wire Format Feature

    NameSupportedDefined By
    JSON✓OAS2,OAS3
    XML✓OAS2,OAS3
    PROTOBUF✗ToolingExtension
    Custom✗OAS2,OAS3
    Edit this page
    Last updated on by Jim Schubert
    +

    Config Options for ada

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    projectNameGNAT project namedefaultProject
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

    IMPORT MAPPING

    Type/AliasImports

    INSTANTIATION TYPES

    Type/AliasInstantiated By

    LANGUAGE PRIMITIVES

    • Boolean
    • Character
    • Integer
    • boolean
    • double
    • float
    • integer
    • long

    RESERVED WORDS

    • abort
    • abs
    • abstract
    • accept
    • access
    • aliased
    • all
    • and
    • array
    • at
    • begin
    • body
    • case
    • constant
    • declare
    • delay
    • digits
    • do
    • else
    • elsif
    • end
    • entry
    • exception
    • exit
    • for
    • function
    • generic
    • goto
    • if
    • in
    • interface
    • is
    • limited
    • loop
    • mod
    • new
    • not
    • null
    • of
    • or
    • others
    • out
    • overriding
    • package
    • pragma
    • private
    • procedure
    • protected
    • raise
    • range
    • record
    • rem
    • renames
    • requeue
    • return
    • reverse
    • select
    • separate
    • some
    • subtype
    • synchronized
    • tagged
    • task
    • terminate
    • then
    • type
    • until
    • use
    • when
    • while
    • with
    • xor

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePath✗ToolingExtension
    Authorizations✗ToolingExtension
    UserAgent✗ToolingExtension

    Data Type Feature

    NameSupportedDefined By
    Custom✗OAS2,OAS3
    Int32✓OAS2,OAS3
    Int64✓OAS2,OAS3
    Float✓OAS2,OAS3
    Double✓OAS2,OAS3
    Decimal✓ToolingExtension
    String✓OAS2,OAS3
    Byte✓OAS2,OAS3
    Binary✓OAS2,OAS3
    Boolean✓OAS2,OAS3
    Date✓OAS2,OAS3
    DateTime✓OAS2,OAS3
    Password✓OAS2,OAS3
    File✓OAS2
    Array✓OAS2,OAS3
    Maps✓ToolingExtension
    CollectionFormat✓OAS2
    CollectionFormatMulti✓OAS2
    Enum✓OAS2,OAS3
    ArrayOfEnum✓ToolingExtension
    ArrayOfModel✓ToolingExtension
    ArrayOfCollectionOfPrimitives✓ToolingExtension
    ArrayOfCollectionOfModel✓ToolingExtension
    ArrayOfCollectionOfEnum✓ToolingExtension
    MapOfEnum✓ToolingExtension
    MapOfModel✓ToolingExtension
    MapOfCollectionOfPrimitives✓ToolingExtension
    MapOfCollectionOfModel✓ToolingExtension
    MapOfCollectionOfEnum✓ToolingExtension

    Documentation Feature

    NameSupportedDefined By
    Readme✗ToolingExtension
    Model✓ToolingExtension
    Api✓ToolingExtension

    Global Feature

    NameSupportedDefined By
    Host✓OAS2,OAS3
    BasePath✓OAS2,OAS3
    Info✓OAS2,OAS3
    Schemes✗OAS2,OAS3
    PartialSchemes✓OAS2,OAS3
    Consumes✓OAS2
    Produces✓OAS2
    ExternalDocumentation✓OAS2,OAS3
    Examples✓OAS2,OAS3
    XMLStructureDefinitions✗OAS2,OAS3
    MultiServer✗OAS3
    ParameterizedServer✗OAS3
    ParameterStyling✗OAS3
    Callbacks✓OAS3
    LinkObjects✗OAS3

    Parameter Feature

    NameSupportedDefined By
    Path✓OAS2,OAS3
    Query✓OAS2,OAS3
    Header✓OAS2,OAS3
    Body✓OAS2
    FormUnencoded✓OAS2
    FormMultipart✓OAS2
    Cookie✓OAS3

    Schema Support Feature

    NameSupportedDefined By
    Simple✓OAS2,OAS3
    Composite✓OAS2,OAS3
    Polymorphism✓OAS2,OAS3
    Union✗OAS3

    Security Feature

    NameSupportedDefined By
    BasicAuth✓OAS2,OAS3
    ApiKey✓OAS2,OAS3
    OpenIDConnect✗OAS3
    BearerToken✓OAS3
    OAuth2_Implicit✓OAS2,OAS3
    OAuth2_Password✓OAS2,OAS3
    OAuth2_ClientCredentials✓OAS2,OAS3
    OAuth2_AuthorizationCode✓OAS2,OAS3

    Wire Format Feature

    NameSupportedDefined By
    JSON✓OAS2,OAS3
    XML✓OAS2,OAS3
    PROTOBUF✗ToolingExtension
    Custom✗OAS2,OAS3
    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/generators/android/index.html b/docs/generators/android/index.html index 278bbfded72..72f108b0183 100644 --- a/docs/generators/android/index.html +++ b/docs/generators/android/index.html @@ -21,26 +21,26 @@ - +
    -

    Config Options for android

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    androidBuildToolsVersionbuildToolsVersion version for use in the generated build.gradlenull
    androidGradleVersiongradleVersion version for use in the generated build.gradlenull
    androidSdkVersioncompileSdkVersion version for use in the generated build.gradlenull
    apiPackagepackage for generated api classesnull
    artifactIdartifactId for use in the generated build.gradle and pom.xmlnull
    artifactVersionartifact version for use in the generated build.gradle and pom.xmlnull
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    groupIdgroupId for use in the generated build.gradle and pom.xmlnull
    invokerPackageroot package for generated codenull
    librarylibrary 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
    modelPackagepackage for generated modelsnull
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
    sourceFoldersource folder for generated codenull
    useAndroidMavenGradlePluginA flag to toggle android-maven gradle plugin.true

    IMPORT MAPPING

    Type/AliasImports
    Arrayjava.util.List
    ArrayListjava.util.ArrayList
    BigDecimaljava.math.BigDecimal
    Datejava.util.Date
    DateTimeorg.joda.time.*
    Filejava.io.File
    HashMapjava.util.HashMap
    Listjava.util.*
    LocalDateorg.joda.time.*
    LocalDateTimeorg.joda.time.*
    LocalTimeorg.joda.time.*
    Mapjava.util.Map
    Setjava.util.*
    Timestampjava.sql.Timestamp
    URIjava.net.URI
    UUIDjava.util.UUID

    INSTANTIATION TYPES

    Type/AliasInstantiated By
    arrayArrayList
    mapHashMap

    LANGUAGE PRIMITIVES

    • Boolean
    • Double
    • Float
    • Integer
    • Long
    • Object
    • String
    • boolean
    • byte[]

    RESERVED WORDS

    • abstract
    • apiinvoker
    • assert
    • authnames
    • basepath
    • boolean
    • break
    • byte
    • case
    • catch
    • char
    • class
    • const
    • continue
    • default
    • do
    • double
    • else
    • enum
    • extends
    • final
    • finally
    • float
    • for
    • goto
    • if
    • implements
    • import
    • instanceof
    • int
    • interface
    • localvarbuilder
    • localvarcontenttype
    • localvarcontenttypes
    • localvarformparams
    • localvarheaderparams
    • localvarpath
    • localvarpostbody
    • localvarqueryparams
    • localvarresponse
    • long
    • native
    • new
    • null
    • object
    • package
    • private
    • protected
    • public
    • return
    • short
    • static
    • strictfp
    • super
    • switch
    • synchronized
    • this
    • throw
    • throws
    • transient
    • try
    • void
    • volatile
    • while

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePath✓ToolingExtension
    Authorizations✗ToolingExtension
    UserAgent✗ToolingExtension

    Data Type Feature

    NameSupportedDefined By
    Custom✗OAS2,OAS3
    Int32✓OAS2,OAS3
    Int64✓OAS2,OAS3
    Float✓OAS2,OAS3
    Double✓OAS2,OAS3
    Decimal✓ToolingExtension
    String✓OAS2,OAS3
    Byte✓OAS2,OAS3
    Binary✓OAS2,OAS3
    Boolean✓OAS2,OAS3
    Date✓OAS2,OAS3
    DateTime✓OAS2,OAS3
    Password✓OAS2,OAS3
    File✓OAS2
    Array✓OAS2,OAS3
    Maps✓ToolingExtension
    CollectionFormat✓OAS2
    CollectionFormatMulti✓OAS2
    Enum✓OAS2,OAS3
    ArrayOfEnum✓ToolingExtension
    ArrayOfModel✓ToolingExtension
    ArrayOfCollectionOfPrimitives✓ToolingExtension
    ArrayOfCollectionOfModel✓ToolingExtension
    ArrayOfCollectionOfEnum✓ToolingExtension
    MapOfEnum✓ToolingExtension
    MapOfModel✓ToolingExtension
    MapOfCollectionOfPrimitives✓ToolingExtension
    MapOfCollectionOfModel✓ToolingExtension
    MapOfCollectionOfEnum✓ToolingExtension

    Documentation Feature

    NameSupportedDefined By
    Readme✓ToolingExtension
    Model✓ToolingExtension
    Api✓ToolingExtension

    Global Feature

    NameSupportedDefined By
    Host✓OAS2,OAS3
    BasePath✓OAS2,OAS3
    Info✓OAS2,OAS3
    Schemes✗OAS2,OAS3
    PartialSchemes✓OAS2,OAS3
    Consumes✓OAS2
    Produces✓OAS2
    ExternalDocumentation✓OAS2,OAS3
    Examples✓OAS2,OAS3
    XMLStructureDefinitions✗OAS2,OAS3
    MultiServer✗OAS3
    ParameterizedServer✗OAS3
    ParameterStyling✗OAS3
    Callbacks✗OAS3
    LinkObjects✗OAS3

    Parameter Feature

    NameSupportedDefined By
    Path✓OAS2,OAS3
    Query✓OAS2,OAS3
    Header✓OAS2,OAS3
    Body✓OAS2
    FormUnencoded✓OAS2
    FormMultipart✓OAS2
    Cookie✗OAS3

    Schema Support Feature

    NameSupportedDefined By
    Simple✓OAS2,OAS3
    Composite✓OAS2,OAS3
    Polymorphism✓OAS2,OAS3
    Union✗OAS3

    Security Feature

    NameSupportedDefined By
    BasicAuth✓OAS2,OAS3
    ApiKey✓OAS2,OAS3
    OpenIDConnect✗OAS3
    BearerToken✗OAS3
    OAuth2_Implicit✗OAS2,OAS3
    OAuth2_Password✗OAS2,OAS3
    OAuth2_ClientCredentials✗OAS2,OAS3
    OAuth2_AuthorizationCode✗OAS2,OAS3

    Wire Format Feature

    NameSupportedDefined By
    JSON✓OAS2,OAS3
    XML✓OAS2,OAS3
    PROTOBUF✗ToolingExtension
    Custom✗OAS2,OAS3
    Edit this page
    Last updated on by Jim Schubert
    +

    Config Options for android

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    androidBuildToolsVersionbuildToolsVersion version for use in the generated build.gradlenull
    androidGradleVersiongradleVersion version for use in the generated build.gradlenull
    androidSdkVersioncompileSdkVersion version for use in the generated build.gradlenull
    apiPackagepackage for generated api classesnull
    artifactIdartifactId for use in the generated build.gradle and pom.xmlnull
    artifactVersionartifact version for use in the generated build.gradle and pom.xmlnull
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    groupIdgroupId for use in the generated build.gradle and pom.xmlnull
    invokerPackageroot package for generated codenull
    librarylibrary 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
    modelPackagepackage for generated modelsnull
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
    sourceFoldersource folder for generated codenull
    useAndroidMavenGradlePluginA flag to toggle android-maven gradle plugin.true

    IMPORT MAPPING

    Type/AliasImports
    Arrayjava.util.List
    ArrayListjava.util.ArrayList
    BigDecimaljava.math.BigDecimal
    Datejava.util.Date
    DateTimeorg.joda.time.*
    Filejava.io.File
    HashMapjava.util.HashMap
    Listjava.util.*
    LocalDateorg.joda.time.*
    LocalDateTimeorg.joda.time.*
    LocalTimeorg.joda.time.*
    Mapjava.util.Map
    Setjava.util.*
    Timestampjava.sql.Timestamp
    URIjava.net.URI
    UUIDjava.util.UUID

    INSTANTIATION TYPES

    Type/AliasInstantiated By
    arrayArrayList
    mapHashMap

    LANGUAGE PRIMITIVES

    • Boolean
    • Double
    • Float
    • Integer
    • Long
    • Object
    • String
    • boolean
    • byte[]

    RESERVED WORDS

    • abstract
    • apiinvoker
    • assert
    • authnames
    • basepath
    • boolean
    • break
    • byte
    • case
    • catch
    • char
    • class
    • const
    • continue
    • default
    • do
    • double
    • else
    • enum
    • extends
    • final
    • finally
    • float
    • for
    • goto
    • if
    • implements
    • import
    • instanceof
    • int
    • interface
    • localvarbuilder
    • localvarcontenttype
    • localvarcontenttypes
    • localvarformparams
    • localvarheaderparams
    • localvarpath
    • localvarpostbody
    • localvarqueryparams
    • localvarresponse
    • long
    • native
    • new
    • null
    • object
    • package
    • private
    • protected
    • public
    • return
    • short
    • static
    • strictfp
    • super
    • switch
    • synchronized
    • this
    • throw
    • throws
    • transient
    • try
    • void
    • volatile
    • while

    FEATURE SET

    Client Modification Feature

    NameSupportedDefined By
    BasePath✓ToolingExtension
    Authorizations✗ToolingExtension
    UserAgent✗ToolingExtension

    Data Type Feature

    NameSupportedDefined By
    Custom✗OAS2,OAS3
    Int32✓OAS2,OAS3
    Int64✓OAS2,OAS3
    Float✓OAS2,OAS3
    Double✓OAS2,OAS3
    Decimal✓ToolingExtension
    String✓OAS2,OAS3
    Byte✓OAS2,OAS3
    Binary✓OAS2,OAS3
    Boolean✓OAS2,OAS3
    Date✓OAS2,OAS3
    DateTime✓OAS2,OAS3
    Password✓OAS2,OAS3
    File✓OAS2
    Array✓OAS2,OAS3
    Maps✓ToolingExtension
    CollectionFormat✓OAS2
    CollectionFormatMulti✓OAS2
    Enum✓OAS2,OAS3
    ArrayOfEnum✓ToolingExtension
    ArrayOfModel✓ToolingExtension
    ArrayOfCollectionOfPrimitives✓ToolingExtension
    ArrayOfCollectionOfModel✓ToolingExtension
    ArrayOfCollectionOfEnum✓ToolingExtension
    MapOfEnum✓ToolingExtension
    MapOfModel✓ToolingExtension
    MapOfCollectionOfPrimitives✓ToolingExtension
    MapOfCollectionOfModel✓ToolingExtension
    MapOfCollectionOfEnum✓ToolingExtension

    Documentation Feature

    NameSupportedDefined By
    Readme✓ToolingExtension
    Model✓ToolingExtension
    Api✓ToolingExtension

    Global Feature

    NameSupportedDefined By
    Host✓OAS2,OAS3
    BasePath✓OAS2,OAS3
    Info✓OAS2,OAS3
    Schemes✗OAS2,OAS3
    PartialSchemes✓OAS2,OAS3
    Consumes✓OAS2
    Produces✓OAS2
    ExternalDocumentation✓OAS2,OAS3
    Examples✓OAS2,OAS3
    XMLStructureDefinitions✗OAS2,OAS3
    MultiServer✗OAS3
    ParameterizedServer✗OAS3
    ParameterStyling✗OAS3
    Callbacks✗OAS3
    LinkObjects✗OAS3

    Parameter Feature

    NameSupportedDefined By
    Path✓OAS2,OAS3
    Query✓OAS2,OAS3
    Header✓OAS2,OAS3
    Body✓OAS2
    FormUnencoded✓OAS2
    FormMultipart✓OAS2
    Cookie✗OAS3

    Schema Support Feature

    NameSupportedDefined By
    Simple✓OAS2,OAS3
    Composite✓OAS2,OAS3
    Polymorphism✓OAS2,OAS3
    Union✗OAS3

    Security Feature

    NameSupportedDefined By
    BasicAuth✓OAS2,OAS3
    ApiKey✓OAS2,OAS3
    OpenIDConnect✗OAS3
    BearerToken✗OAS3
    OAuth2_Implicit✗OAS2,OAS3
    OAuth2_Password✗OAS2,OAS3
    OAuth2_ClientCredentials✗OAS2,OAS3
    OAuth2_AuthorizationCode✗OAS2,OAS3

    Wire Format Feature

    NameSupportedDefined By
    JSON✓OAS2,OAS3
    XML✓OAS2,OAS3
    PROTOBUF✗ToolingExtension
    Custom✗OAS2,OAS3
    Edit this page
    Last updated on by Jim Schubert
    - + - + - + diff --git a/docs/generators/apache2/index.html b/docs/generators/apache2/index.html index 582b99e9702..ad9f6b63a65 100644 --- a/docs/generators/apache2/index.html +++ b/docs/generators/apache2/index.html @@ -21,26 +21,26 @@ - +
    -

    Config Options for apache2

    OptionDescriptionValuesDefault
    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
    userInfoPathPath to the user and group filesnull

    IMPORT MAPPING

    Type/AliasImports
    Arrayjava.util.List
    ArrayListjava.util.ArrayList
    BigDecimaljava.math.BigDecimal
    Datejava.util.Date
    DateTimeorg.joda.time.*
    Filejava.io.File
    HashMapjava.util.HashMap
    Listjava.util.*
    LocalDateorg.joda.time.*
    LocalDateTimeorg.joda.time.*
    LocalTimeorg.joda.time.*
    Mapjava.util.Map
    Setjava.util.*
    Timestampjava.sql.Timestamp
    URIjava.net.URI
    UUIDjava.util.UUID

    INSTANTIATION TYPES

    Type/AliasInstantiated By

    LANGUAGE PRIMITIVES

      RESERVED WORDS

        FEATURE SET

        Client Modification Feature

        NameSupportedDefined By
        BasePath✗ToolingExtension
        Authorizations✗ToolingExtension
        UserAgent✗ToolingExtension

        Data Type Feature

        NameSupportedDefined By
        Custom✗OAS2,OAS3
        Int32✗OAS2,OAS3
        Int64✗OAS2,OAS3
        Float✗OAS2,OAS3
        Double✗OAS2,OAS3
        Decimal✗ToolingExtension
        String✗OAS2,OAS3
        Byte✗OAS2,OAS3
        Binary✗OAS2,OAS3
        Boolean✗OAS2,OAS3
        Date✗OAS2,OAS3
        DateTime✗OAS2,OAS3
        Password✗OAS2,OAS3
        File✗OAS2
        Array✗OAS2,OAS3
        Maps✗ToolingExtension
        CollectionFormat✗OAS2
        CollectionFormatMulti✗OAS2
        Enum✗OAS2,OAS3
        ArrayOfEnum✗ToolingExtension
        ArrayOfModel✗ToolingExtension
        ArrayOfCollectionOfPrimitives✗ToolingExtension
        ArrayOfCollectionOfModel✗ToolingExtension
        ArrayOfCollectionOfEnum✗ToolingExtension
        MapOfEnum✗ToolingExtension
        MapOfModel✗ToolingExtension
        MapOfCollectionOfPrimitives✗ToolingExtension
        MapOfCollectionOfModel✗ToolingExtension
        MapOfCollectionOfEnum✗ToolingExtension

        Documentation Feature

        NameSupportedDefined By
        Readme✗ToolingExtension
        Model✗ToolingExtension
        Api✗ToolingExtension

        Global Feature

        NameSupportedDefined By
        Host✗OAS2,OAS3
        BasePath✗OAS2,OAS3
        Info✗OAS2,OAS3
        Schemes✗OAS2,OAS3
        PartialSchemes✗OAS2,OAS3
        Consumes✗OAS2
        Produces✗OAS2
        ExternalDocumentation✗OAS2,OAS3
        Examples✗OAS2,OAS3
        XMLStructureDefinitions✗OAS2,OAS3
        MultiServer✗OAS3
        ParameterizedServer✗OAS3
        ParameterStyling✗OAS3
        Callbacks✗OAS3
        LinkObjects✗OAS3

        Parameter Feature

        NameSupportedDefined By
        Path✓OAS2,OAS3
        Query✗OAS2,OAS3
        Header✗OAS2,OAS3
        Body✗OAS2
        FormUnencoded✗OAS2
        FormMultipart✗OAS2
        Cookie✗OAS3

        Schema Support Feature

        NameSupportedDefined By
        Simple✗OAS2,OAS3
        Composite✗OAS2,OAS3
        Polymorphism✗OAS2,OAS3
        Union✗OAS3

        Security Feature

        NameSupportedDefined By
        BasicAuth✓OAS2,OAS3
        ApiKey✗OAS2,OAS3
        OpenIDConnect✗OAS3
        BearerToken✗OAS3
        OAuth2_Implicit✗OAS2,OAS3
        OAuth2_Password✗OAS2,OAS3
        OAuth2_ClientCredentials✗OAS2,OAS3
        OAuth2_AuthorizationCode✗OAS2,OAS3

        Wire Format Feature

        NameSupportedDefined By
        JSON✗OAS2,OAS3
        XML✗OAS2,OAS3
        PROTOBUF✗ToolingExtension
        Custom✗OAS2,OAS3
        Edit this page
        Last updated on by Jim Schubert
        +

        Config Options for apache2

        OptionDescriptionValuesDefault
        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
        userInfoPathPath to the user and group filesnull

        IMPORT MAPPING

        Type/AliasImports
        Arrayjava.util.List
        ArrayListjava.util.ArrayList
        BigDecimaljava.math.BigDecimal
        Datejava.util.Date
        DateTimeorg.joda.time.*
        Filejava.io.File
        HashMapjava.util.HashMap
        Listjava.util.*
        LocalDateorg.joda.time.*
        LocalDateTimeorg.joda.time.*
        LocalTimeorg.joda.time.*
        Mapjava.util.Map
        Setjava.util.*
        Timestampjava.sql.Timestamp
        URIjava.net.URI
        UUIDjava.util.UUID

        INSTANTIATION TYPES

        Type/AliasInstantiated By

        LANGUAGE PRIMITIVES

          RESERVED WORDS

            FEATURE SET

            Client Modification Feature

            NameSupportedDefined By
            BasePath✗ToolingExtension
            Authorizations✗ToolingExtension
            UserAgent✗ToolingExtension

            Data Type Feature

            NameSupportedDefined By
            Custom✗OAS2,OAS3
            Int32✗OAS2,OAS3
            Int64✗OAS2,OAS3
            Float✗OAS2,OAS3
            Double✗OAS2,OAS3
            Decimal✗ToolingExtension
            String✗OAS2,OAS3
            Byte✗OAS2,OAS3
            Binary✗OAS2,OAS3
            Boolean✗OAS2,OAS3
            Date✗OAS2,OAS3
            DateTime✗OAS2,OAS3
            Password✗OAS2,OAS3
            File✗OAS2
            Array✗OAS2,OAS3
            Maps✗ToolingExtension
            CollectionFormat✗OAS2
            CollectionFormatMulti✗OAS2
            Enum✗OAS2,OAS3
            ArrayOfEnum✗ToolingExtension
            ArrayOfModel✗ToolingExtension
            ArrayOfCollectionOfPrimitives✗ToolingExtension
            ArrayOfCollectionOfModel✗ToolingExtension
            ArrayOfCollectionOfEnum✗ToolingExtension
            MapOfEnum✗ToolingExtension
            MapOfModel✗ToolingExtension
            MapOfCollectionOfPrimitives✗ToolingExtension
            MapOfCollectionOfModel✗ToolingExtension
            MapOfCollectionOfEnum✗ToolingExtension

            Documentation Feature

            NameSupportedDefined By
            Readme✗ToolingExtension
            Model✗ToolingExtension
            Api✗ToolingExtension

            Global Feature

            NameSupportedDefined By
            Host✗OAS2,OAS3
            BasePath✗OAS2,OAS3
            Info✗OAS2,OAS3
            Schemes✗OAS2,OAS3
            PartialSchemes✗OAS2,OAS3
            Consumes✗OAS2
            Produces✗OAS2
            ExternalDocumentation✗OAS2,OAS3
            Examples✗OAS2,OAS3
            XMLStructureDefinitions✗OAS2,OAS3
            MultiServer✗OAS3
            ParameterizedServer✗OAS3
            ParameterStyling✗OAS3
            Callbacks✗OAS3
            LinkObjects✗OAS3

            Parameter Feature

            NameSupportedDefined By
            Path✓OAS2,OAS3
            Query✗OAS2,OAS3
            Header✗OAS2,OAS3
            Body✗OAS2
            FormUnencoded✗OAS2
            FormMultipart✗OAS2
            Cookie✗OAS3

            Schema Support Feature

            NameSupportedDefined By
            Simple✗OAS2,OAS3
            Composite✗OAS2,OAS3
            Polymorphism✗OAS2,OAS3
            Union✗OAS3

            Security Feature

            NameSupportedDefined By
            BasicAuth✓OAS2,OAS3
            ApiKey✗OAS2,OAS3
            OpenIDConnect✗OAS3
            BearerToken✗OAS3
            OAuth2_Implicit✗OAS2,OAS3
            OAuth2_Password✗OAS2,OAS3
            OAuth2_ClientCredentials✗OAS2,OAS3
            OAuth2_AuthorizationCode✗OAS2,OAS3

            Wire Format Feature

            NameSupportedDefined By
            JSON✗OAS2,OAS3
            XML✗OAS2,OAS3
            PROTOBUF✗ToolingExtension
            Custom✗OAS2,OAS3
            Edit this page
            Last updated on by Jim Schubert
            - + - + - + diff --git a/docs/generators/apex/index.html b/docs/generators/apex/index.html index 7d923357c24..1aee59a018f 100644 --- a/docs/generators/apex/index.html +++ b/docs/generators/apex/index.html @@ -21,26 +21,26 @@ - +
            -

            Config Options for apex

            OptionDescriptionValuesDefault
            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
            apiVersionThe Metadata API version number to use for components in this package.null
            buildMethodThe build method for this package.null
            classPrefixPrefix for generated classes. Set this to avoid overwriting existing classes in your org.null
            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
            namedCredentialThe named credential name for the HTTP calloutsnull
            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

            IMPORT MAPPING

            Type/AliasImports

            INSTANTIATION TYPES

            Type/AliasInstantiated By
            arrayList
            mapMap

            LANGUAGE PRIMITIVES

            • Blob
            • Boolean
            • Date
            • Datetime
            • Decimal
            • Double
            • ID
            • Integer
            • Long
            • Object
            • String
            • Time

            RESERVED WORDS

            • abstract
            • activate
            • and
            • any
            • array
            • as
            • asc
            • autonomous
            • begin
            • bigdecimal
            • blob
            • break
            • bulk
            • by
            • byte
            • case
            • cast
            • catch
            • char
            • class
            • collect
            • commit
            • const
            • continue
            • convertcurrency
            • currency
            • date
            • datetime
            • decimal
            • default
            • delete
            • desc
            • do
            • else
            • end
            • enum
            • exception
            • exit
            • export
            • extends
            • false
            • final
            • finally
            • float
            • for
            • from
            • future
            • global
            • goto
            • group
            • having
            • hint
            • if
            • implements
            • import
            • in
            • inner
            • insert
            • instanceof
            • int
            • interface
            • into
            • join
            • last_90_days
            • last_month
            • last_n_days
            • last_week
            • like
            • limit
            • list
            • long
            • loop
            • map
            • merge
            • new
            • next_90_days
            • next_month
            • next_n_days
            • next_week
            • not
            • null
            • nulls
            • number
            • object
            • of
            • on
            • or
            • outer
            • override
            • package
            • parallel
            • pragma
            • private
            • protected
            • public
            • retrieve
            • return
            • returning
            • rollback
            • savepoint
            • search
            • select
            • set
            • short
            • sort
            • stat
            • static
            • super
            • switch
            • synchronized
            • system
            • testmethod
            • then
            • this
            • this_month
            • this_week
            • throw
            • time
            • today
            • tolabel
            • tomorrow
            • transaction
            • trigger
            • true
            • try
            • type
            • undelete
            • update
            • upsert
            • using
            • virtual
            • webservice
            • when
            • where
            • while
            • yesterday

            FEATURE SET

            Client Modification Feature

            NameSupportedDefined By
            BasePath✗ToolingExtension
            Authorizations✗ToolingExtension
            UserAgent✗ToolingExtension

            Data Type Feature

            NameSupportedDefined By
            Custom✗OAS2,OAS3
            Int32✓OAS2,OAS3
            Int64✓OAS2,OAS3
            Float✓OAS2,OAS3
            Double✓OAS2,OAS3
            Decimal✓ToolingExtension
            String✓OAS2,OAS3
            Byte✓OAS2,OAS3
            Binary✓OAS2,OAS3
            Boolean✓OAS2,OAS3
            Date✓OAS2,OAS3
            DateTime✓OAS2,OAS3
            Password✓OAS2,OAS3
            File✓OAS2
            Array✓OAS2,OAS3
            Maps✓ToolingExtension
            CollectionFormat✓OAS2
            CollectionFormatMulti✓OAS2
            Enum✓OAS2,OAS3
            ArrayOfEnum✓ToolingExtension
            ArrayOfModel✓ToolingExtension
            ArrayOfCollectionOfPrimitives✓ToolingExtension
            ArrayOfCollectionOfModel✓ToolingExtension
            ArrayOfCollectionOfEnum✓ToolingExtension
            MapOfEnum✓ToolingExtension
            MapOfModel✓ToolingExtension
            MapOfCollectionOfPrimitives✓ToolingExtension
            MapOfCollectionOfModel✓ToolingExtension
            MapOfCollectionOfEnum✓ToolingExtension

            Documentation Feature

            NameSupportedDefined By
            Readme✗ToolingExtension
            Model✓ToolingExtension
            Api✓ToolingExtension

            Global Feature

            NameSupportedDefined By
            Host✓OAS2,OAS3
            BasePath✓OAS2,OAS3
            Info✓OAS2,OAS3
            Schemes✗OAS2,OAS3
            PartialSchemes✓OAS2,OAS3
            Consumes✓OAS2
            Produces✓OAS2
            ExternalDocumentation✓OAS2,OAS3
            Examples✓OAS2,OAS3
            XMLStructureDefinitions✗OAS2,OAS3
            MultiServer✗OAS3
            ParameterizedServer✗OAS3
            ParameterStyling✗OAS3
            Callbacks✓OAS3
            LinkObjects✗OAS3

            Parameter Feature

            NameSupportedDefined By
            Path✓OAS2,OAS3
            Query✓OAS2,OAS3
            Header✓OAS2,OAS3
            Body✓OAS2
            FormUnencoded✓OAS2
            FormMultipart✓OAS2
            Cookie✓OAS3

            Schema Support Feature

            NameSupportedDefined By
            Simple✓OAS2,OAS3
            Composite✓OAS2,OAS3
            Polymorphism✓OAS2,OAS3
            Union✗OAS3

            Security Feature

            NameSupportedDefined By
            BasicAuth✓OAS2,OAS3
            ApiKey✓OAS2,OAS3
            OpenIDConnect✗OAS3
            BearerToken✓OAS3
            OAuth2_Implicit✓OAS2,OAS3
            OAuth2_Password✓OAS2,OAS3
            OAuth2_ClientCredentials✓OAS2,OAS3
            OAuth2_AuthorizationCode✓OAS2,OAS3

            Wire Format Feature

            NameSupportedDefined By
            JSON✓OAS2,OAS3
            XML✓OAS2,OAS3
            PROTOBUF✗ToolingExtension
            Custom✗OAS2,OAS3
            Edit this page
            Last updated on by Jim Schubert
            +

            Config Options for apex

            OptionDescriptionValuesDefault
            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
            apiVersionThe Metadata API version number to use for components in this package.null
            buildMethodThe build method for this package.null
            classPrefixPrefix for generated classes. Set this to avoid overwriting existing classes in your org.null
            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
            namedCredentialThe named credential name for the HTTP calloutsnull
            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

            IMPORT MAPPING

            Type/AliasImports

            INSTANTIATION TYPES

            Type/AliasInstantiated By
            arrayList
            mapMap

            LANGUAGE PRIMITIVES

            • Blob
            • Boolean
            • Date
            • Datetime
            • Decimal
            • Double
            • ID
            • Integer
            • Long
            • Object
            • String
            • Time

            RESERVED WORDS

            • abstract
            • activate
            • and
            • any
            • array
            • as
            • asc
            • autonomous
            • begin
            • bigdecimal
            • blob
            • break
            • bulk
            • by
            • byte
            • case
            • cast
            • catch
            • char
            • class
            • collect
            • commit
            • const
            • continue
            • convertcurrency
            • currency
            • date
            • datetime
            • decimal
            • default
            • delete
            • desc
            • do
            • else
            • end
            • enum
            • exception
            • exit
            • export
            • extends
            • false
            • final
            • finally
            • float
            • for
            • from
            • future
            • global
            • goto
            • group
            • having
            • hint
            • if
            • implements
            • import
            • in
            • inner
            • insert
            • instanceof
            • int
            • interface
            • into
            • join
            • last_90_days
            • last_month
            • last_n_days
            • last_week
            • like
            • limit
            • list
            • long
            • loop
            • map
            • merge
            • new
            • next_90_days
            • next_month
            • next_n_days
            • next_week
            • not
            • null
            • nulls
            • number
            • object
            • of
            • on
            • or
            • outer
            • override
            • package
            • parallel
            • pragma
            • private
            • protected
            • public
            • retrieve
            • return
            • returning
            • rollback
            • savepoint
            • search
            • select
            • set
            • short
            • sort
            • stat
            • static
            • super
            • switch
            • synchronized
            • system
            • testmethod
            • then
            • this
            • this_month
            • this_week
            • throw
            • time
            • today
            • tolabel
            • tomorrow
            • transaction
            • trigger
            • true
            • try
            • type
            • undelete
            • update
            • upsert
            • using
            • virtual
            • webservice
            • when
            • where
            • while
            • yesterday

            FEATURE SET

            Client Modification Feature

            NameSupportedDefined By
            BasePath✗ToolingExtension
            Authorizations✗ToolingExtension
            UserAgent✗ToolingExtension

            Data Type Feature

            NameSupportedDefined By
            Custom✗OAS2,OAS3
            Int32✓OAS2,OAS3
            Int64✓OAS2,OAS3
            Float✓OAS2,OAS3
            Double✓OAS2,OAS3
            Decimal✓ToolingExtension
            String✓OAS2,OAS3
            Byte✓OAS2,OAS3
            Binary✓OAS2,OAS3
            Boolean✓OAS2,OAS3
            Date✓OAS2,OAS3
            DateTime✓OAS2,OAS3
            Password✓OAS2,OAS3
            File✓OAS2
            Array✓OAS2,OAS3
            Maps✓ToolingExtension
            CollectionFormat✓OAS2
            CollectionFormatMulti✓OAS2
            Enum✓OAS2,OAS3
            ArrayOfEnum✓ToolingExtension
            ArrayOfModel✓ToolingExtension
            ArrayOfCollectionOfPrimitives✓ToolingExtension
            ArrayOfCollectionOfModel✓ToolingExtension
            ArrayOfCollectionOfEnum✓ToolingExtension
            MapOfEnum✓ToolingExtension
            MapOfModel✓ToolingExtension
            MapOfCollectionOfPrimitives✓ToolingExtension
            MapOfCollectionOfModel✓ToolingExtension
            MapOfCollectionOfEnum✓ToolingExtension

            Documentation Feature

            NameSupportedDefined By
            Readme✗ToolingExtension
            Model✓ToolingExtension
            Api✓ToolingExtension

            Global Feature

            NameSupportedDefined By
            Host✓OAS2,OAS3
            BasePath✓OAS2,OAS3
            Info✓OAS2,OAS3
            Schemes✗OAS2,OAS3
            PartialSchemes✓OAS2,OAS3
            Consumes✓OAS2
            Produces✓OAS2
            ExternalDocumentation✓OAS2,OAS3
            Examples✓OAS2,OAS3
            XMLStructureDefinitions✗OAS2,OAS3
            MultiServer✗OAS3
            ParameterizedServer✗OAS3
            ParameterStyling✗OAS3
            Callbacks✓OAS3
            LinkObjects✗OAS3

            Parameter Feature

            NameSupportedDefined By
            Path✓OAS2,OAS3
            Query✓OAS2,OAS3
            Header✓OAS2,OAS3
            Body✓OAS2
            FormUnencoded✓OAS2
            FormMultipart✓OAS2
            Cookie✓OAS3

            Schema Support Feature

            NameSupportedDefined By
            Simple✓OAS2,OAS3
            Composite✓OAS2,OAS3
            Polymorphism✓OAS2,OAS3
            Union✗OAS3

            Security Feature

            NameSupportedDefined By
            BasicAuth✓OAS2,OAS3
            ApiKey✓OAS2,OAS3
            OpenIDConnect✗OAS3
            BearerToken✓OAS3
            OAuth2_Implicit✓OAS2,OAS3
            OAuth2_Password✓OAS2,OAS3
            OAuth2_ClientCredentials✓OAS2,OAS3
            OAuth2_AuthorizationCode✓OAS2,OAS3

            Wire Format Feature

            NameSupportedDefined By
            JSON✓OAS2,OAS3
            XML✓OAS2,OAS3
            PROTOBUF✗ToolingExtension
            Custom✗OAS2,OAS3
            Edit this page
            Last updated on by Jim Schubert
            - + - + - + diff --git a/docs/generators/asciidoc/index.html b/docs/generators/asciidoc/index.html index ec7563c5681..a66ceb9058e 100644 --- a/docs/generators/asciidoc/index.html +++ b/docs/generators/asciidoc/index.html @@ -21,26 +21,26 @@ - +
            -

            Config Options for asciidoc

            OptionDescriptionValuesDefault
            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
            appDescriptiondescription of the applicationnull
            appNameshort name of the applicationnull
            artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
            artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
            groupIdgroupId in generated pom.xmlnull
            headerAttributesgeneration of asciidoc header meta data attributes (set to false to suppress, default: true)true
            infoEmailan email address to contact for inquiries about the applicationnull
            infoUrla URL where users can get more information about the applicationnull
            invokerPackageroot package for generated codenull
            licenseInfoa short description of the licensenull
            licenseUrla URL pointing to the full licensenull
            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
            snippetDirpath with includable markup snippets (e.g. test output generated by restdoc, default: .).
            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
            specDirpath with includable markup spec files (e.g. handwritten additional docs, default: ..)..

            IMPORT MAPPING

            Type/AliasImports

            INSTANTIATION TYPES

            Type/AliasInstantiated By

            LANGUAGE PRIMITIVES

              RESERVED WORDS

                FEATURE SET

                Client Modification Feature

                NameSupportedDefined By
                BasePath✗ToolingExtension
                Authorizations✗ToolingExtension
                UserAgent✗ToolingExtension

                Data Type Feature

                NameSupportedDefined By
                Custom✗OAS2,OAS3
                Int32✓OAS2,OAS3
                Int64✓OAS2,OAS3
                Float✓OAS2,OAS3
                Double✓OAS2,OAS3
                Decimal✓ToolingExtension
                String✓OAS2,OAS3
                Byte✓OAS2,OAS3
                Binary✓OAS2,OAS3
                Boolean✓OAS2,OAS3
                Date✓OAS2,OAS3
                DateTime✓OAS2,OAS3
                Password✓OAS2,OAS3
                File✓OAS2
                Array✓OAS2,OAS3
                Maps✓ToolingExtension
                CollectionFormat✓OAS2
                CollectionFormatMulti✓OAS2
                Enum✓OAS2,OAS3
                ArrayOfEnum✓ToolingExtension
                ArrayOfModel✓ToolingExtension
                ArrayOfCollectionOfPrimitives✓ToolingExtension
                ArrayOfCollectionOfModel✓ToolingExtension
                ArrayOfCollectionOfEnum✓ToolingExtension
                MapOfEnum✓ToolingExtension
                MapOfModel✓ToolingExtension
                MapOfCollectionOfPrimitives✓ToolingExtension
                MapOfCollectionOfModel✓ToolingExtension
                MapOfCollectionOfEnum✓ToolingExtension

                Documentation Feature

                NameSupportedDefined By
                Readme✗ToolingExtension
                Model✗ToolingExtension
                Api✗ToolingExtension

                Global Feature

                NameSupportedDefined By
                Host✗OAS2,OAS3
                BasePath✗OAS2,OAS3
                Info✗OAS2,OAS3
                Schemes✗OAS2,OAS3
                PartialSchemes✗OAS2,OAS3
                Consumes✗OAS2
                Produces✗OAS2
                ExternalDocumentation✗OAS2,OAS3
                Examples✗OAS2,OAS3
                XMLStructureDefinitions✗OAS2,OAS3
                MultiServer✗OAS3
                ParameterizedServer✗OAS3
                ParameterStyling✗OAS3
                Callbacks✗OAS3
                LinkObjects✗OAS3

                Parameter Feature

                NameSupportedDefined By
                Path✓OAS2,OAS3
                Query✓OAS2,OAS3
                Header✓OAS2,OAS3
                Body✓OAS2
                FormUnencoded✓OAS2
                FormMultipart✓OAS2
                Cookie✓OAS3

                Schema Support Feature

                NameSupportedDefined By
                Simple✗OAS2,OAS3
                Composite✗OAS2,OAS3
                Polymorphism✗OAS2,OAS3
                Union✗OAS3

                Security Feature

                NameSupportedDefined By
                BasicAuth✗OAS2,OAS3
                ApiKey✗OAS2,OAS3
                OpenIDConnect✗OAS3
                BearerToken✗OAS3
                OAuth2_Implicit✗OAS2,OAS3
                OAuth2_Password✗OAS2,OAS3
                OAuth2_ClientCredentials✗OAS2,OAS3
                OAuth2_AuthorizationCode✗OAS2,OAS3

                Wire Format Feature

                NameSupportedDefined By
                JSON✓OAS2,OAS3
                XML✓OAS2,OAS3
                PROTOBUF✗ToolingExtension
                Custom✗OAS2,OAS3
                Edit this page
                Last updated on by Jim Schubert
                +

                Config Options for asciidoc

                OptionDescriptionValuesDefault
                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                appDescriptiondescription of the applicationnull
                appNameshort name of the applicationnull
                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                groupIdgroupId in generated pom.xmlnull
                headerAttributesgeneration of asciidoc header meta data attributes (set to false to suppress, default: true)true
                infoEmailan email address to contact for inquiries about the applicationnull
                infoUrla URL where users can get more information about the applicationnull
                invokerPackageroot package for generated codenull
                licenseInfoa short description of the licensenull
                licenseUrla URL pointing to the full licensenull
                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                snippetDirpath with includable markup snippets (e.g. test output generated by restdoc, default: .).
                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                specDirpath with includable markup spec files (e.g. handwritten additional docs, default: ..)..

                IMPORT MAPPING

                Type/AliasImports

                INSTANTIATION TYPES

                Type/AliasInstantiated By

                LANGUAGE PRIMITIVES

                  RESERVED WORDS

                    FEATURE SET

                    Client Modification Feature

                    NameSupportedDefined By
                    BasePath✗ToolingExtension
                    Authorizations✗ToolingExtension
                    UserAgent✗ToolingExtension

                    Data Type Feature

                    NameSupportedDefined By
                    Custom✗OAS2,OAS3
                    Int32✓OAS2,OAS3
                    Int64✓OAS2,OAS3
                    Float✓OAS2,OAS3
                    Double✓OAS2,OAS3
                    Decimal✓ToolingExtension
                    String✓OAS2,OAS3
                    Byte✓OAS2,OAS3
                    Binary✓OAS2,OAS3
                    Boolean✓OAS2,OAS3
                    Date✓OAS2,OAS3
                    DateTime✓OAS2,OAS3
                    Password✓OAS2,OAS3
                    File✓OAS2
                    Array✓OAS2,OAS3
                    Maps✓ToolingExtension
                    CollectionFormat✓OAS2
                    CollectionFormatMulti✓OAS2
                    Enum✓OAS2,OAS3
                    ArrayOfEnum✓ToolingExtension
                    ArrayOfModel✓ToolingExtension
                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                    ArrayOfCollectionOfModel✓ToolingExtension
                    ArrayOfCollectionOfEnum✓ToolingExtension
                    MapOfEnum✓ToolingExtension
                    MapOfModel✓ToolingExtension
                    MapOfCollectionOfPrimitives✓ToolingExtension
                    MapOfCollectionOfModel✓ToolingExtension
                    MapOfCollectionOfEnum✓ToolingExtension

                    Documentation Feature

                    NameSupportedDefined By
                    Readme✗ToolingExtension
                    Model✗ToolingExtension
                    Api✗ToolingExtension

                    Global Feature

                    NameSupportedDefined By
                    Host✗OAS2,OAS3
                    BasePath✗OAS2,OAS3
                    Info✗OAS2,OAS3
                    Schemes✗OAS2,OAS3
                    PartialSchemes✗OAS2,OAS3
                    Consumes✗OAS2
                    Produces✗OAS2
                    ExternalDocumentation✗OAS2,OAS3
                    Examples✗OAS2,OAS3
                    XMLStructureDefinitions✗OAS2,OAS3
                    MultiServer✗OAS3
                    ParameterizedServer✗OAS3
                    ParameterStyling✗OAS3
                    Callbacks✗OAS3
                    LinkObjects✗OAS3

                    Parameter Feature

                    NameSupportedDefined By
                    Path✓OAS2,OAS3
                    Query✓OAS2,OAS3
                    Header✓OAS2,OAS3
                    Body✓OAS2
                    FormUnencoded✓OAS2
                    FormMultipart✓OAS2
                    Cookie✓OAS3

                    Schema Support Feature

                    NameSupportedDefined By
                    Simple✗OAS2,OAS3
                    Composite✗OAS2,OAS3
                    Polymorphism✗OAS2,OAS3
                    Union✗OAS3

                    Security Feature

                    NameSupportedDefined By
                    BasicAuth✗OAS2,OAS3
                    ApiKey✗OAS2,OAS3
                    OpenIDConnect✗OAS3
                    BearerToken✗OAS3
                    OAuth2_Implicit✗OAS2,OAS3
                    OAuth2_Password✗OAS2,OAS3
                    OAuth2_ClientCredentials✗OAS2,OAS3
                    OAuth2_AuthorizationCode✗OAS2,OAS3

                    Wire Format Feature

                    NameSupportedDefined By
                    JSON✓OAS2,OAS3
                    XML✓OAS2,OAS3
                    PROTOBUF✗ToolingExtension
                    Custom✗OAS2,OAS3
                    Edit this page
                    Last updated on by Jim Schubert
                    - + - + - + diff --git a/docs/generators/aspnetcore/index.html b/docs/generators/aspnetcore/index.html index 5094370161b..edeefdb222a 100644 --- a/docs/generators/aspnetcore/index.html +++ b/docs/generators/aspnetcore/index.html @@ -21,26 +21,26 @@ - +
                    -

                    Config Options for aspnetcore

                    OptionDescriptionValuesDefault
                    aspnetCoreVersionASP.NET Core version: 3.0 (preview4 only), 2.2, 2.1, 2.0 (deprecated)2.2
                    buildTargetTarget to build an application or libraryprogram
                    classModifierClass Modifier can be empty, abstract
                    compatibilityVersionASP.Net Core CompatibilityVersionVersion_2_2
                    enumNameSuffixSuffix that will be appended to all enum names.Enum
                    enumValueSuffixSuffix that will be appended to all enum values.Enum
                    generateBodyGenerates method body.true
                    isLibraryIs the build a libraryfalse
                    licenseNameThe name of the licenseNoLicense
                    licenseUrlThe URL of the licensehttp://localhost
                    modelClassModifierModel Class Modifier can be nothing or partialpartial
                    newtonsoftVersionVersion for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+3.0.0-preview5-19227-01
                    operationIsAsyncSet methods to async or sync (default).false
                    operationModifierOperation Modifier can be virtual, abstract or partialvirtual
                    operationResultTaskSet methods result to Task<>.false
                    packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                    packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                    packageGuidThe GUID that will be associated with the C# projectnull
                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                    packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                    packageVersionC# package version.1.0.0
                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                    sourceFoldersource folder for generated codesrc
                    swashbuckleVersionSwashbucke version: 3.0.0, 4.0.03.0.0
                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                    useDefaultRoutingUse default routing for the ASP.NET Core version. For 3.0 turn off default because it is not yet supported.true
                    useFrameworkReferenceUse frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.false
                    useNewtonsoftUses the Newtonsoft JSON library.true
                    useSwashbuckleUses the Swashbuckle.AspNetCore NuGet package for documentation.true

                    IMPORT MAPPING

                    Type/AliasImports

                    INSTANTIATION TYPES

                    Type/AliasInstantiated By
                    arrayList
                    listList
                    mapDictionary

                    LANGUAGE PRIMITIVES

                    • Boolean
                    • Collection
                    • DateTime
                    • DateTime?
                    • DateTimeOffset
                    • DateTimeOffset?
                    • Dictionary
                    • Double
                    • Float
                    • Guid
                    • Guid?
                    • ICollection
                    • Int32
                    • Int64
                    • List
                    • Object
                    • String
                    • System.IO.Stream
                    • bool
                    • bool?
                    • byte[]
                    • decimal
                    • decimal?
                    • double
                    • double?
                    • float
                    • float?
                    • int
                    • int?
                    • long
                    • long?
                    • string

                    RESERVED WORDS

                    • Client
                    • abstract
                    • as
                    • async
                    • await
                    • base
                    • bool
                    • break
                    • byte
                    • case
                    • catch
                    • char
                    • checked
                    • class
                    • client
                    • const
                    • continue
                    • decimal
                    • default
                    • delegate
                    • do
                    • double
                    • dynamic
                    • else
                    • enum
                    • event
                    • explicit
                    • extern
                    • false
                    • finally
                    • fixed
                    • float
                    • for
                    • foreach
                    • goto
                    • if
                    • implicit
                    • in
                    • int
                    • interface
                    • internal
                    • is
                    • localVarFileParams
                    • localVarFormParams
                    • localVarHeaderParams
                    • localVarHttpContentType
                    • localVarHttpContentTypes
                    • localVarHttpHeaderAccept
                    • localVarHttpHeaderAccepts
                    • localVarPath
                    • localVarPathParams
                    • localVarPostBody
                    • localVarQueryParams
                    • localVarResponse
                    • localVarStatusCode
                    • lock
                    • long
                    • namespace
                    • new
                    • null
                    • object
                    • operator
                    • out
                    • override
                    • parameter
                    • params
                    • private
                    • protected
                    • public
                    • readonly
                    • ref
                    • return
                    • sbyte
                    • sealed
                    • short
                    • sizeof
                    • stackalloc
                    • static
                    • string
                    • struct
                    • switch
                    • this
                    • throw
                    • true
                    • try
                    • typeof
                    • uint
                    • ulong
                    • unchecked
                    • unsafe
                    • ushort
                    • using
                    • var
                    • virtual
                    • void
                    • volatile
                    • while
                    • yield

                    FEATURE SET

                    Client Modification Feature

                    NameSupportedDefined By
                    BasePath✗ToolingExtension
                    Authorizations✗ToolingExtension
                    UserAgent✗ToolingExtension

                    Data Type Feature

                    NameSupportedDefined By
                    Custom✗OAS2,OAS3
                    Int32✓OAS2,OAS3
                    Int64✓OAS2,OAS3
                    Float✓OAS2,OAS3
                    Double✓OAS2,OAS3
                    Decimal✓ToolingExtension
                    String✓OAS2,OAS3
                    Byte✓OAS2,OAS3
                    Binary✓OAS2,OAS3
                    Boolean✓OAS2,OAS3
                    Date✓OAS2,OAS3
                    DateTime✓OAS2,OAS3
                    Password✓OAS2,OAS3
                    File✓OAS2
                    Array✓OAS2,OAS3
                    Maps✓ToolingExtension
                    CollectionFormat✓OAS2
                    CollectionFormatMulti✓OAS2
                    Enum✓OAS2,OAS3
                    ArrayOfEnum✓ToolingExtension
                    ArrayOfModel✓ToolingExtension
                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                    ArrayOfCollectionOfModel✓ToolingExtension
                    ArrayOfCollectionOfEnum✓ToolingExtension
                    MapOfEnum✓ToolingExtension
                    MapOfModel✓ToolingExtension
                    MapOfCollectionOfPrimitives✓ToolingExtension
                    MapOfCollectionOfModel✓ToolingExtension
                    MapOfCollectionOfEnum✓ToolingExtension

                    Documentation Feature

                    NameSupportedDefined By
                    Readme✓ToolingExtension
                    Model✓ToolingExtension
                    Api✓ToolingExtension

                    Global Feature

                    NameSupportedDefined By
                    Host✓OAS2,OAS3
                    BasePath✓OAS2,OAS3
                    Info✓OAS2,OAS3
                    Schemes✗OAS2,OAS3
                    PartialSchemes✓OAS2,OAS3
                    Consumes✓OAS2
                    Produces✓OAS2
                    ExternalDocumentation✓OAS2,OAS3
                    Examples✓OAS2,OAS3
                    XMLStructureDefinitions✗OAS2,OAS3
                    MultiServer✗OAS3
                    ParameterizedServer✗OAS3
                    ParameterStyling✗OAS3
                    Callbacks✗OAS3
                    LinkObjects✗OAS3

                    Parameter Feature

                    NameSupportedDefined By
                    Path✓OAS2,OAS3
                    Query✓OAS2,OAS3
                    Header✓OAS2,OAS3
                    Body✓OAS2
                    FormUnencoded✓OAS2
                    FormMultipart✓OAS2
                    Cookie✓OAS3

                    Schema Support Feature

                    NameSupportedDefined By
                    Simple✓OAS2,OAS3
                    Composite✓OAS2,OAS3
                    Polymorphism✓OAS2,OAS3
                    Union✗OAS3

                    Security Feature

                    NameSupportedDefined By
                    BasicAuth✓OAS2,OAS3
                    ApiKey✓OAS2,OAS3
                    OpenIDConnect✗OAS3
                    BearerToken✓OAS3
                    OAuth2_Implicit✗OAS2,OAS3
                    OAuth2_Password✗OAS2,OAS3
                    OAuth2_ClientCredentials✗OAS2,OAS3
                    OAuth2_AuthorizationCode✗OAS2,OAS3

                    Wire Format Feature

                    NameSupportedDefined By
                    JSON✓OAS2,OAS3
                    XML✓OAS2,OAS3
                    PROTOBUF✗ToolingExtension
                    Custom✗OAS2,OAS3
                    Edit this page
                    Last updated on by Jim Schubert
                    +

                    Config Options for aspnetcore

                    OptionDescriptionValuesDefault
                    aspnetCoreVersionASP.NET Core version: 3.0 (preview4 only), 2.2, 2.1, 2.0 (deprecated)2.2
                    buildTargetTarget to build an application or libraryprogram
                    classModifierClass Modifier can be empty, abstract
                    compatibilityVersionASP.Net Core CompatibilityVersionVersion_2_2
                    enumNameSuffixSuffix that will be appended to all enum names.Enum
                    enumValueSuffixSuffix that will be appended to all enum values.Enum
                    generateBodyGenerates method body.true
                    isLibraryIs the build a libraryfalse
                    licenseNameThe name of the licenseNoLicense
                    licenseUrlThe URL of the licensehttp://localhost
                    modelClassModifierModel Class Modifier can be nothing or partialpartial
                    newtonsoftVersionVersion for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+3.0.0-preview5-19227-01
                    operationIsAsyncSet methods to async or sync (default).false
                    operationModifierOperation Modifier can be virtual, abstract or partialvirtual
                    operationResultTaskSet methods result to Task<>.false
                    packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                    packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                    packageGuidThe GUID that will be associated with the C# projectnull
                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                    packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                    packageVersionC# package version.1.0.0
                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                    sourceFoldersource folder for generated codesrc
                    swashbuckleVersionSwashbucke version: 3.0.0, 4.0.03.0.0
                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                    useDefaultRoutingUse default routing for the ASP.NET Core version. For 3.0 turn off default because it is not yet supported.true
                    useFrameworkReferenceUse frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.false
                    useNewtonsoftUses the Newtonsoft JSON library.true
                    useSwashbuckleUses the Swashbuckle.AspNetCore NuGet package for documentation.true

                    IMPORT MAPPING

                    Type/AliasImports

                    INSTANTIATION TYPES

                    Type/AliasInstantiated By
                    arrayList
                    listList
                    mapDictionary

                    LANGUAGE PRIMITIVES

                    • Boolean
                    • Collection
                    • DateTime
                    • DateTime?
                    • DateTimeOffset
                    • DateTimeOffset?
                    • Dictionary
                    • Double
                    • Float
                    • Guid
                    • Guid?
                    • ICollection
                    • Int32
                    • Int64
                    • List
                    • Object
                    • String
                    • System.IO.Stream
                    • bool
                    • bool?
                    • byte[]
                    • decimal
                    • decimal?
                    • double
                    • double?
                    • float
                    • float?
                    • int
                    • int?
                    • long
                    • long?
                    • string

                    RESERVED WORDS

                    • Client
                    • abstract
                    • as
                    • async
                    • await
                    • base
                    • bool
                    • break
                    • byte
                    • case
                    • catch
                    • char
                    • checked
                    • class
                    • client
                    • const
                    • continue
                    • decimal
                    • default
                    • delegate
                    • do
                    • double
                    • dynamic
                    • else
                    • enum
                    • event
                    • explicit
                    • extern
                    • false
                    • finally
                    • fixed
                    • float
                    • for
                    • foreach
                    • goto
                    • if
                    • implicit
                    • in
                    • int
                    • interface
                    • internal
                    • is
                    • localVarFileParams
                    • localVarFormParams
                    • localVarHeaderParams
                    • localVarHttpContentType
                    • localVarHttpContentTypes
                    • localVarHttpHeaderAccept
                    • localVarHttpHeaderAccepts
                    • localVarPath
                    • localVarPathParams
                    • localVarPostBody
                    • localVarQueryParams
                    • localVarResponse
                    • localVarStatusCode
                    • lock
                    • long
                    • namespace
                    • new
                    • null
                    • object
                    • operator
                    • out
                    • override
                    • parameter
                    • params
                    • private
                    • protected
                    • public
                    • readonly
                    • ref
                    • return
                    • sbyte
                    • sealed
                    • short
                    • sizeof
                    • stackalloc
                    • static
                    • string
                    • struct
                    • switch
                    • this
                    • throw
                    • true
                    • try
                    • typeof
                    • uint
                    • ulong
                    • unchecked
                    • unsafe
                    • ushort
                    • using
                    • var
                    • virtual
                    • void
                    • volatile
                    • while
                    • yield

                    FEATURE SET

                    Client Modification Feature

                    NameSupportedDefined By
                    BasePath✗ToolingExtension
                    Authorizations✗ToolingExtension
                    UserAgent✗ToolingExtension

                    Data Type Feature

                    NameSupportedDefined By
                    Custom✗OAS2,OAS3
                    Int32✓OAS2,OAS3
                    Int64✓OAS2,OAS3
                    Float✓OAS2,OAS3
                    Double✓OAS2,OAS3
                    Decimal✓ToolingExtension
                    String✓OAS2,OAS3
                    Byte✓OAS2,OAS3
                    Binary✓OAS2,OAS3
                    Boolean✓OAS2,OAS3
                    Date✓OAS2,OAS3
                    DateTime✓OAS2,OAS3
                    Password✓OAS2,OAS3
                    File✓OAS2
                    Array✓OAS2,OAS3
                    Maps✓ToolingExtension
                    CollectionFormat✓OAS2
                    CollectionFormatMulti✓OAS2
                    Enum✓OAS2,OAS3
                    ArrayOfEnum✓ToolingExtension
                    ArrayOfModel✓ToolingExtension
                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                    ArrayOfCollectionOfModel✓ToolingExtension
                    ArrayOfCollectionOfEnum✓ToolingExtension
                    MapOfEnum✓ToolingExtension
                    MapOfModel✓ToolingExtension
                    MapOfCollectionOfPrimitives✓ToolingExtension
                    MapOfCollectionOfModel✓ToolingExtension
                    MapOfCollectionOfEnum✓ToolingExtension

                    Documentation Feature

                    NameSupportedDefined By
                    Readme✓ToolingExtension
                    Model✓ToolingExtension
                    Api✓ToolingExtension

                    Global Feature

                    NameSupportedDefined By
                    Host✓OAS2,OAS3
                    BasePath✓OAS2,OAS3
                    Info✓OAS2,OAS3
                    Schemes✗OAS2,OAS3
                    PartialSchemes✓OAS2,OAS3
                    Consumes✓OAS2
                    Produces✓OAS2
                    ExternalDocumentation✓OAS2,OAS3
                    Examples✓OAS2,OAS3
                    XMLStructureDefinitions✗OAS2,OAS3
                    MultiServer✗OAS3
                    ParameterizedServer✗OAS3
                    ParameterStyling✗OAS3
                    Callbacks✗OAS3
                    LinkObjects✗OAS3

                    Parameter Feature

                    NameSupportedDefined By
                    Path✓OAS2,OAS3
                    Query✓OAS2,OAS3
                    Header✓OAS2,OAS3
                    Body✓OAS2
                    FormUnencoded✓OAS2
                    FormMultipart✓OAS2
                    Cookie✓OAS3

                    Schema Support Feature

                    NameSupportedDefined By
                    Simple✓OAS2,OAS3
                    Composite✓OAS2,OAS3
                    Polymorphism✓OAS2,OAS3
                    Union✗OAS3

                    Security Feature

                    NameSupportedDefined By
                    BasicAuth✓OAS2,OAS3
                    ApiKey✓OAS2,OAS3
                    OpenIDConnect✗OAS3
                    BearerToken✓OAS3
                    OAuth2_Implicit✗OAS2,OAS3
                    OAuth2_Password✗OAS2,OAS3
                    OAuth2_ClientCredentials✗OAS2,OAS3
                    OAuth2_AuthorizationCode✗OAS2,OAS3

                    Wire Format Feature

                    NameSupportedDefined By
                    JSON✓OAS2,OAS3
                    XML✓OAS2,OAS3
                    PROTOBUF✗ToolingExtension
                    Custom✗OAS2,OAS3
                    Edit this page
                    Last updated on by Jim Schubert
                    - + - + - + diff --git a/docs/generators/avro-schema/index.html b/docs/generators/avro-schema/index.html index 45e416c5d90..7c0581558ac 100644 --- a/docs/generators/avro-schema/index.html +++ b/docs/generators/avro-schema/index.html @@ -21,26 +21,26 @@ - +
                    -

                    Config Options for avro-schema

                    OptionDescriptionValuesDefault
                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                    packageNamepackage for generated classes (where supported)null
                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                    IMPORT MAPPING

                    Type/AliasImports

                    INSTANTIATION TYPES

                    Type/AliasInstantiated By
                    arrayArray
                    listArray
                    mapObject

                    LANGUAGE PRIMITIVES

                    • BigDecimal
                    • DateTime
                    • UUID
                    • boolean
                    • bytes
                    • date
                    • double
                    • float
                    • int
                    • integer
                    • long
                    • null
                    • number
                    • string

                    RESERVED WORDS

                      FEATURE SET

                      Client Modification Feature

                      NameSupportedDefined By
                      BasePath✗ToolingExtension
                      Authorizations✗ToolingExtension
                      UserAgent✗ToolingExtension

                      Data Type Feature

                      NameSupportedDefined By
                      Custom✗OAS2,OAS3
                      Int32✓OAS2,OAS3
                      Int64✓OAS2,OAS3
                      Float✓OAS2,OAS3
                      Double✓OAS2,OAS3
                      Decimal✓ToolingExtension
                      String✓OAS2,OAS3
                      Byte✓OAS2,OAS3
                      Binary✓OAS2,OAS3
                      Boolean✓OAS2,OAS3
                      Date✓OAS2,OAS3
                      DateTime✓OAS2,OAS3
                      Password✓OAS2,OAS3
                      File✓OAS2
                      Array✓OAS2,OAS3
                      Maps✓ToolingExtension
                      CollectionFormat✓OAS2
                      CollectionFormatMulti✓OAS2
                      Enum✓OAS2,OAS3
                      ArrayOfEnum✓ToolingExtension
                      ArrayOfModel✓ToolingExtension
                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                      ArrayOfCollectionOfModel✓ToolingExtension
                      ArrayOfCollectionOfEnum✓ToolingExtension
                      MapOfEnum✓ToolingExtension
                      MapOfModel✓ToolingExtension
                      MapOfCollectionOfPrimitives✓ToolingExtension
                      MapOfCollectionOfModel✓ToolingExtension
                      MapOfCollectionOfEnum✓ToolingExtension

                      Documentation Feature

                      NameSupportedDefined By
                      Readme✗ToolingExtension
                      Model✗ToolingExtension
                      Api✗ToolingExtension

                      Global Feature

                      NameSupportedDefined By
                      Host✗OAS2,OAS3
                      BasePath✗OAS2,OAS3
                      Info✗OAS2,OAS3
                      Schemes✗OAS2,OAS3
                      PartialSchemes✗OAS2,OAS3
                      Consumes✗OAS2
                      Produces✗OAS2
                      ExternalDocumentation✗OAS2,OAS3
                      Examples✗OAS2,OAS3
                      XMLStructureDefinitions✗OAS2,OAS3
                      MultiServer✗OAS3
                      ParameterizedServer✗OAS3
                      ParameterStyling✗OAS3
                      Callbacks✗OAS3
                      LinkObjects✗OAS3

                      Parameter Feature

                      NameSupportedDefined By
                      Path✗OAS2,OAS3
                      Query✗OAS2,OAS3
                      Header✗OAS2,OAS3
                      Body✗OAS2
                      FormUnencoded✗OAS2
                      FormMultipart✗OAS2
                      Cookie✗OAS3

                      Schema Support Feature

                      NameSupportedDefined By
                      Simple✓OAS2,OAS3
                      Composite✓OAS2,OAS3
                      Polymorphism✗OAS2,OAS3
                      Union✗OAS3

                      Security Feature

                      NameSupportedDefined By
                      BasicAuth✗OAS2,OAS3
                      ApiKey✗OAS2,OAS3
                      OpenIDConnect✗OAS3
                      BearerToken✗OAS3
                      OAuth2_Implicit✗OAS2,OAS3
                      OAuth2_Password✗OAS2,OAS3
                      OAuth2_ClientCredentials✗OAS2,OAS3
                      OAuth2_AuthorizationCode✗OAS2,OAS3

                      Wire Format Feature

                      NameSupportedDefined By
                      JSON✗OAS2,OAS3
                      XML✗OAS2,OAS3
                      PROTOBUF✗ToolingExtension
                      Custom✗OAS2,OAS3
                      Edit this page
                      Last updated on by Jim Schubert
                      +

                      Config Options for avro-schema

                      OptionDescriptionValuesDefault
                      allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                      ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                      packageNamepackage for generated classes (where supported)null
                      prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                      sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                      sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                      IMPORT MAPPING

                      Type/AliasImports

                      INSTANTIATION TYPES

                      Type/AliasInstantiated By
                      arrayArray
                      listArray
                      mapObject

                      LANGUAGE PRIMITIVES

                      • BigDecimal
                      • DateTime
                      • UUID
                      • boolean
                      • bytes
                      • date
                      • double
                      • float
                      • int
                      • integer
                      • long
                      • null
                      • number
                      • string

                      RESERVED WORDS

                        FEATURE SET

                        Client Modification Feature

                        NameSupportedDefined By
                        BasePath✗ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension

                        Data Type Feature

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Array✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature

                        NameSupportedDefined By
                        Readme✗ToolingExtension
                        Model✗ToolingExtension
                        Api✗ToolingExtension

                        Global Feature

                        NameSupportedDefined By
                        Host✗OAS2,OAS3
                        BasePath✗OAS2,OAS3
                        Info✗OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✗OAS2,OAS3
                        Consumes✗OAS2
                        Produces✗OAS2
                        ExternalDocumentation✗OAS2,OAS3
                        Examples✗OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✗OAS3
                        LinkObjects✗OAS3

                        Parameter Feature

                        NameSupportedDefined By
                        Path✗OAS2,OAS3
                        Query✗OAS2,OAS3
                        Header✗OAS2,OAS3
                        Body✗OAS2
                        FormUnencoded✗OAS2
                        FormMultipart✗OAS2
                        Cookie✗OAS3

                        Schema Support Feature

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3

                        Security Feature

                        NameSupportedDefined By
                        BasicAuth✗OAS2,OAS3
                        ApiKey✗OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✗OAS3
                        OAuth2_Implicit✗OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3

                        Wire Format Feature

                        NameSupportedDefined By
                        JSON✗OAS2,OAS3
                        XML✗OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✗OAS2,OAS3
                        Edit this page
                        Last updated on by Jim Schubert
                        - + - + - + diff --git a/docs/generators/bash/index.html b/docs/generators/bash/index.html index 80a301d7817..d98463f8080 100644 --- a/docs/generators/bash/index.html +++ b/docs/generators/bash/index.html @@ -21,26 +21,26 @@ - +
                        -

                        Config Options for bash

                        OptionDescriptionValuesDefault
                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                        apiKeyAuthEnvironmentVariableName of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')false
                        basicAuthEnvironmentVariableName of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')null
                        curlOptionsDefault cURL optionsnull
                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                        generateBashCompletionWhether to generate the Bash completion scriptfalse
                        generateZshCompletionWhether to generate the Zsh completion scriptfalse
                        hostEnvironmentVariableName of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')null
                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                        processMarkdownConvert all Markdown Markup into terminal formattingfalse
                        scriptNameThe name of the script that will be generated (e.g. petstore-cli)null
                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                        IMPORT MAPPING

                        Type/AliasImports
                        Arrayjava.util.List
                        ArrayListjava.util.ArrayList
                        BigDecimaljava.math.BigDecimal
                        Datejava.util.Date
                        DateTimeorg.joda.time.*
                        Filejava.io.File
                        HashMapjava.util.HashMap
                        Listjava.util.*
                        LocalDateorg.joda.time.*
                        LocalDateTimeorg.joda.time.*
                        LocalTimeorg.joda.time.*
                        Mapjava.util.Map
                        Setjava.util.*
                        Timestampjava.sql.Timestamp
                        URIjava.net.URI
                        UUIDjava.util.UUID

                        INSTANTIATION TYPES

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES

                        • array
                        • binary
                        • boolean
                        • float
                        • integer
                        • map
                        • string

                        RESERVED WORDS

                        • case
                        • do
                        • done
                        • elif
                        • else
                        • esac
                        • fi
                        • for
                        • function
                        • if
                        • in
                        • select
                        • then
                        • time
                        • until
                        • while

                        FEATURE SET

                        Client Modification Feature

                        NameSupportedDefined By
                        BasePath✗ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension

                        Data Type Feature

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Array✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✗ToolingExtension
                        Api✗ToolingExtension

                        Global Feature

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✓OAS3
                        LinkObjects✗OAS3

                        Parameter Feature

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✓OAS3

                        Schema Support Feature

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3

                        Security Feature

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✓OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✓OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3

                        Wire Format Feature

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✓OAS2,OAS3
                        Edit this page
                        Last updated on by Jim Schubert
                        +

                        Config Options for bash

                        OptionDescriptionValuesDefault
                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                        apiKeyAuthEnvironmentVariableName of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')false
                        basicAuthEnvironmentVariableName of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')null
                        curlOptionsDefault cURL optionsnull
                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                        generateBashCompletionWhether to generate the Bash completion scriptfalse
                        generateZshCompletionWhether to generate the Zsh completion scriptfalse
                        hostEnvironmentVariableName of environment variable where host can be defined (e.g. PETSTORE_HOST='http://api.openapitools.org:8080')null
                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                        processMarkdownConvert all Markdown Markup into terminal formattingfalse
                        scriptNameThe name of the script that will be generated (e.g. petstore-cli)null
                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                        IMPORT MAPPING

                        Type/AliasImports
                        Arrayjava.util.List
                        ArrayListjava.util.ArrayList
                        BigDecimaljava.math.BigDecimal
                        Datejava.util.Date
                        DateTimeorg.joda.time.*
                        Filejava.io.File
                        HashMapjava.util.HashMap
                        Listjava.util.*
                        LocalDateorg.joda.time.*
                        LocalDateTimeorg.joda.time.*
                        LocalTimeorg.joda.time.*
                        Mapjava.util.Map
                        Setjava.util.*
                        Timestampjava.sql.Timestamp
                        URIjava.net.URI
                        UUIDjava.util.UUID

                        INSTANTIATION TYPES

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES

                        • array
                        • binary
                        • boolean
                        • float
                        • integer
                        • map
                        • string

                        RESERVED WORDS

                        • case
                        • do
                        • done
                        • elif
                        • else
                        • esac
                        • fi
                        • for
                        • function
                        • if
                        • in
                        • select
                        • then
                        • time
                        • until
                        • while

                        FEATURE SET

                        Client Modification Feature

                        NameSupportedDefined By
                        BasePath✗ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension

                        Data Type Feature

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Array✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✗ToolingExtension
                        Api✗ToolingExtension

                        Global Feature

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✓OAS3
                        LinkObjects✗OAS3

                        Parameter Feature

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✓OAS3

                        Schema Support Feature

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3

                        Security Feature

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✓OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✓OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3

                        Wire Format Feature

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✓OAS2,OAS3
                        Edit this page
                        Last updated on by Jim Schubert
                        - + - + - + diff --git a/docs/generators/c/index.html b/docs/generators/c/index.html index 1bea6f06866..cac3001f220 100644 --- a/docs/generators/c/index.html +++ b/docs/generators/c/index.html @@ -21,26 +21,26 @@ - +
                        -

                        Config Options for c

                        OptionDescriptionValuesDefault
                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                        IMPORT MAPPING

                        Type/AliasImports

                        INSTANTIATION TYPES

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES

                        • Object
                        • binary_t*
                        • char
                        • double
                        • float
                        • int
                        • list
                        • list_t*
                        • long
                        • short

                        RESERVED WORDS

                        • _alignas
                        • _alignof
                        • _atomic
                        • _bool
                        • _complex
                        • _generic
                        • _imaginary
                        • _noreturn
                        • _static_assert
                        • _thread_local
                        • auto
                        • break
                        • case
                        • char
                        • const
                        • continue
                        • default
                        • do
                        • double
                        • else
                        • enum
                        • extern
                        • float
                        • for
                        • goto
                        • if
                        • inline
                        • int
                        • long
                        • register
                        • remove
                        • restrict
                        • return
                        • short
                        • signed
                        • sizeof
                        • static
                        • struct
                        • switch
                        • typedef
                        • union
                        • unsigned
                        • void
                        • volatile
                        • while

                        FEATURE SET

                        Client Modification Feature

                        NameSupportedDefined By
                        BasePath✗ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension

                        Data Type Feature

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Array✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✓ToolingExtension
                        Api✓ToolingExtension

                        Global Feature

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✓OAS3
                        LinkObjects✗OAS3

                        Parameter Feature

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✗OAS3

                        Schema Support Feature

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3

                        Security Feature

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✓OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✗OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3

                        Wire Format Feature

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✗OAS2,OAS3
                        Edit this page
                        Last updated on by Jim Schubert
                        +

                        Config Options for c

                        OptionDescriptionValuesDefault
                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                        IMPORT MAPPING

                        Type/AliasImports

                        INSTANTIATION TYPES

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES

                        • Object
                        • binary_t*
                        • char
                        • double
                        • float
                        • int
                        • list
                        • list_t*
                        • long
                        • short

                        RESERVED WORDS

                        • _alignas
                        • _alignof
                        • _atomic
                        • _bool
                        • _complex
                        • _generic
                        • _imaginary
                        • _noreturn
                        • _static_assert
                        • _thread_local
                        • auto
                        • break
                        • case
                        • char
                        • const
                        • continue
                        • default
                        • do
                        • double
                        • else
                        • enum
                        • extern
                        • float
                        • for
                        • goto
                        • if
                        • inline
                        • int
                        • long
                        • register
                        • remove
                        • restrict
                        • return
                        • short
                        • signed
                        • sizeof
                        • static
                        • struct
                        • switch
                        • typedef
                        • union
                        • unsigned
                        • void
                        • volatile
                        • while

                        FEATURE SET

                        Client Modification Feature

                        NameSupportedDefined By
                        BasePath✗ToolingExtension
                        Authorizations✗ToolingExtension
                        UserAgent✗ToolingExtension

                        Data Type Feature

                        NameSupportedDefined By
                        Custom✗OAS2,OAS3
                        Int32✓OAS2,OAS3
                        Int64✓OAS2,OAS3
                        Float✓OAS2,OAS3
                        Double✓OAS2,OAS3
                        Decimal✓ToolingExtension
                        String✓OAS2,OAS3
                        Byte✓OAS2,OAS3
                        Binary✓OAS2,OAS3
                        Boolean✓OAS2,OAS3
                        Date✓OAS2,OAS3
                        DateTime✓OAS2,OAS3
                        Password✓OAS2,OAS3
                        File✓OAS2
                        Array✓OAS2,OAS3
                        Maps✓ToolingExtension
                        CollectionFormat✓OAS2
                        CollectionFormatMulti✓OAS2
                        Enum✓OAS2,OAS3
                        ArrayOfEnum✓ToolingExtension
                        ArrayOfModel✓ToolingExtension
                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                        ArrayOfCollectionOfModel✓ToolingExtension
                        ArrayOfCollectionOfEnum✓ToolingExtension
                        MapOfEnum✓ToolingExtension
                        MapOfModel✓ToolingExtension
                        MapOfCollectionOfPrimitives✓ToolingExtension
                        MapOfCollectionOfModel✓ToolingExtension
                        MapOfCollectionOfEnum✓ToolingExtension

                        Documentation Feature

                        NameSupportedDefined By
                        Readme✓ToolingExtension
                        Model✓ToolingExtension
                        Api✓ToolingExtension

                        Global Feature

                        NameSupportedDefined By
                        Host✓OAS2,OAS3
                        BasePath✓OAS2,OAS3
                        Info✓OAS2,OAS3
                        Schemes✗OAS2,OAS3
                        PartialSchemes✓OAS2,OAS3
                        Consumes✓OAS2
                        Produces✓OAS2
                        ExternalDocumentation✓OAS2,OAS3
                        Examples✓OAS2,OAS3
                        XMLStructureDefinitions✗OAS2,OAS3
                        MultiServer✗OAS3
                        ParameterizedServer✗OAS3
                        ParameterStyling✗OAS3
                        Callbacks✓OAS3
                        LinkObjects✗OAS3

                        Parameter Feature

                        NameSupportedDefined By
                        Path✓OAS2,OAS3
                        Query✓OAS2,OAS3
                        Header✓OAS2,OAS3
                        Body✓OAS2
                        FormUnencoded✓OAS2
                        FormMultipart✓OAS2
                        Cookie✗OAS3

                        Schema Support Feature

                        NameSupportedDefined By
                        Simple✓OAS2,OAS3
                        Composite✓OAS2,OAS3
                        Polymorphism✗OAS2,OAS3
                        Union✗OAS3

                        Security Feature

                        NameSupportedDefined By
                        BasicAuth✓OAS2,OAS3
                        ApiKey✓OAS2,OAS3
                        OpenIDConnect✗OAS3
                        BearerToken✗OAS3
                        OAuth2_Implicit✓OAS2,OAS3
                        OAuth2_Password✗OAS2,OAS3
                        OAuth2_ClientCredentials✗OAS2,OAS3
                        OAuth2_AuthorizationCode✗OAS2,OAS3

                        Wire Format Feature

                        NameSupportedDefined By
                        JSON✓OAS2,OAS3
                        XML✓OAS2,OAS3
                        PROTOBUF✗ToolingExtension
                        Custom✗OAS2,OAS3
                        Edit this page
                        Last updated on by Jim Schubert
                        - + - + - + diff --git a/docs/generators/clojure/index.html b/docs/generators/clojure/index.html index 3c1806bbd20..11ec55ecfbc 100644 --- a/docs/generators/clojure/index.html +++ b/docs/generators/clojure/index.html @@ -21,26 +21,26 @@ - +
                        -

                        Config Options for clojure

                        OptionDescriptionValuesDefault
                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                        baseNamespacethe base/top namespace (Default: generated from projectName)null
                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                        projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                        projectLicenseNamename of the license the project uses (Default: using info.license.name or not included in project.clj)null
                        projectLicenseUrlURL of the license the project uses (Default: using info.license.url or not included in project.clj)null
                        projectNamename of the project (Default: generated from info.title or "openapi-clj-client")null
                        projectUrlURL of the project (Default: using info.contact.url or not included in project.clj)null
                        projectVersionversion of the project (Default: using info.version or "1.0.0")null
                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                        IMPORT MAPPING

                        Type/AliasImports
                        Arrayjava.util.List
                        ArrayListjava.util.ArrayList
                        BigDecimaljava.math.BigDecimal
                        Datejava.util.Date
                        DateTimeorg.joda.time.*
                        Filejava.io.File
                        HashMapjava.util.HashMap
                        Listjava.util.*
                        LocalDateorg.joda.time.*
                        LocalDateTimeorg.joda.time.*
                        LocalTimeorg.joda.time.*
                        Mapjava.util.Map
                        Setjava.util.*
                        Timestampjava.sql.Timestamp
                        URIjava.net.URI
                        UUIDjava.util.UUID

                        INSTANTIATION TYPES

                        Type/AliasInstantiated By

                        LANGUAGE PRIMITIVES

                          RESERVED WORDS

                            FEATURE SET

                            Client Modification Feature

                            NameSupportedDefined By
                            BasePath✗ToolingExtension
                            Authorizations✗ToolingExtension
                            UserAgent✗ToolingExtension

                            Data Type Feature

                            NameSupportedDefined By
                            Custom✗OAS2,OAS3
                            Int32✓OAS2,OAS3
                            Int64✓OAS2,OAS3
                            Float✓OAS2,OAS3
                            Double✓OAS2,OAS3
                            Decimal✓ToolingExtension
                            String✓OAS2,OAS3
                            Byte✓OAS2,OAS3
                            Binary✓OAS2,OAS3
                            Boolean✓OAS2,OAS3
                            Date✓OAS2,OAS3
                            DateTime✓OAS2,OAS3
                            Password✓OAS2,OAS3
                            File✓OAS2
                            Array✓OAS2,OAS3
                            Maps✓ToolingExtension
                            CollectionFormat✓OAS2
                            CollectionFormatMulti✓OAS2
                            Enum✓OAS2,OAS3
                            ArrayOfEnum✓ToolingExtension
                            ArrayOfModel✓ToolingExtension
                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                            ArrayOfCollectionOfModel✓ToolingExtension
                            ArrayOfCollectionOfEnum✓ToolingExtension
                            MapOfEnum✓ToolingExtension
                            MapOfModel✓ToolingExtension
                            MapOfCollectionOfPrimitives✓ToolingExtension
                            MapOfCollectionOfModel✓ToolingExtension
                            MapOfCollectionOfEnum✓ToolingExtension

                            Documentation Feature

                            NameSupportedDefined By
                            Readme✗ToolingExtension
                            Model✓ToolingExtension
                            Api✓ToolingExtension

                            Global Feature

                            NameSupportedDefined By
                            Host✓OAS2,OAS3
                            BasePath✓OAS2,OAS3
                            Info✓OAS2,OAS3
                            Schemes✗OAS2,OAS3
                            PartialSchemes✓OAS2,OAS3
                            Consumes✓OAS2
                            Produces✓OAS2
                            ExternalDocumentation✓OAS2,OAS3
                            Examples✓OAS2,OAS3
                            XMLStructureDefinitions✗OAS2,OAS3
                            MultiServer✗OAS3
                            ParameterizedServer✗OAS3
                            ParameterStyling✗OAS3
                            Callbacks✓OAS3
                            LinkObjects✗OAS3

                            Parameter Feature

                            NameSupportedDefined By
                            Path✓OAS2,OAS3
                            Query✓OAS2,OAS3
                            Header✓OAS2,OAS3
                            Body✓OAS2
                            FormUnencoded✓OAS2
                            FormMultipart✓OAS2
                            Cookie✗OAS3

                            Schema Support Feature

                            NameSupportedDefined By
                            Simple✓OAS2,OAS3
                            Composite✓OAS2,OAS3
                            Polymorphism✗OAS2,OAS3
                            Union✗OAS3

                            Security Feature

                            NameSupportedDefined By
                            BasicAuth✓OAS2,OAS3
                            ApiKey✓OAS2,OAS3
                            OpenIDConnect✗OAS3
                            BearerToken✗OAS3
                            OAuth2_Implicit✓OAS2,OAS3
                            OAuth2_Password✗OAS2,OAS3
                            OAuth2_ClientCredentials✗OAS2,OAS3
                            OAuth2_AuthorizationCode✗OAS2,OAS3

                            Wire Format Feature

                            NameSupportedDefined By
                            JSON✓OAS2,OAS3
                            XML✓OAS2,OAS3
                            PROTOBUF✗ToolingExtension
                            Custom✗OAS2,OAS3
                            Edit this page
                            Last updated on by Jim Schubert
                            +

                            Config Options for clojure

                            OptionDescriptionValuesDefault
                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                            baseNamespacethe base/top namespace (Default: generated from projectName)null
                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                            projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                            projectLicenseNamename of the license the project uses (Default: using info.license.name or not included in project.clj)null
                            projectLicenseUrlURL of the license the project uses (Default: using info.license.url or not included in project.clj)null
                            projectNamename of the project (Default: generated from info.title or "openapi-clj-client")null
                            projectUrlURL of the project (Default: using info.contact.url or not included in project.clj)null
                            projectVersionversion of the project (Default: using info.version or "1.0.0")null
                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                            IMPORT MAPPING

                            Type/AliasImports
                            Arrayjava.util.List
                            ArrayListjava.util.ArrayList
                            BigDecimaljava.math.BigDecimal
                            Datejava.util.Date
                            DateTimeorg.joda.time.*
                            Filejava.io.File
                            HashMapjava.util.HashMap
                            Listjava.util.*
                            LocalDateorg.joda.time.*
                            LocalDateTimeorg.joda.time.*
                            LocalTimeorg.joda.time.*
                            Mapjava.util.Map
                            Setjava.util.*
                            Timestampjava.sql.Timestamp
                            URIjava.net.URI
                            UUIDjava.util.UUID

                            INSTANTIATION TYPES

                            Type/AliasInstantiated By

                            LANGUAGE PRIMITIVES

                              RESERVED WORDS

                                FEATURE SET

                                Client Modification Feature

                                NameSupportedDefined By
                                BasePath✗ToolingExtension
                                Authorizations✗ToolingExtension
                                UserAgent✗ToolingExtension

                                Data Type Feature

                                NameSupportedDefined By
                                Custom✗OAS2,OAS3
                                Int32✓OAS2,OAS3
                                Int64✓OAS2,OAS3
                                Float✓OAS2,OAS3
                                Double✓OAS2,OAS3
                                Decimal✓ToolingExtension
                                String✓OAS2,OAS3
                                Byte✓OAS2,OAS3
                                Binary✓OAS2,OAS3
                                Boolean✓OAS2,OAS3
                                Date✓OAS2,OAS3
                                DateTime✓OAS2,OAS3
                                Password✓OAS2,OAS3
                                File✓OAS2
                                Array✓OAS2,OAS3
                                Maps✓ToolingExtension
                                CollectionFormat✓OAS2
                                CollectionFormatMulti✓OAS2
                                Enum✓OAS2,OAS3
                                ArrayOfEnum✓ToolingExtension
                                ArrayOfModel✓ToolingExtension
                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                ArrayOfCollectionOfModel✓ToolingExtension
                                ArrayOfCollectionOfEnum✓ToolingExtension
                                MapOfEnum✓ToolingExtension
                                MapOfModel✓ToolingExtension
                                MapOfCollectionOfPrimitives✓ToolingExtension
                                MapOfCollectionOfModel✓ToolingExtension
                                MapOfCollectionOfEnum✓ToolingExtension

                                Documentation Feature

                                NameSupportedDefined By
                                Readme✗ToolingExtension
                                Model✓ToolingExtension
                                Api✓ToolingExtension

                                Global Feature

                                NameSupportedDefined By
                                Host✓OAS2,OAS3
                                BasePath✓OAS2,OAS3
                                Info✓OAS2,OAS3
                                Schemes✗OAS2,OAS3
                                PartialSchemes✓OAS2,OAS3
                                Consumes✓OAS2
                                Produces✓OAS2
                                ExternalDocumentation✓OAS2,OAS3
                                Examples✓OAS2,OAS3
                                XMLStructureDefinitions✗OAS2,OAS3
                                MultiServer✗OAS3
                                ParameterizedServer✗OAS3
                                ParameterStyling✗OAS3
                                Callbacks✓OAS3
                                LinkObjects✗OAS3

                                Parameter Feature

                                NameSupportedDefined By
                                Path✓OAS2,OAS3
                                Query✓OAS2,OAS3
                                Header✓OAS2,OAS3
                                Body✓OAS2
                                FormUnencoded✓OAS2
                                FormMultipart✓OAS2
                                Cookie✗OAS3

                                Schema Support Feature

                                NameSupportedDefined By
                                Simple✓OAS2,OAS3
                                Composite✓OAS2,OAS3
                                Polymorphism✗OAS2,OAS3
                                Union✗OAS3

                                Security Feature

                                NameSupportedDefined By
                                BasicAuth✓OAS2,OAS3
                                ApiKey✓OAS2,OAS3
                                OpenIDConnect✗OAS3
                                BearerToken✗OAS3
                                OAuth2_Implicit✓OAS2,OAS3
                                OAuth2_Password✗OAS2,OAS3
                                OAuth2_ClientCredentials✗OAS2,OAS3
                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                Wire Format Feature

                                NameSupportedDefined By
                                JSON✓OAS2,OAS3
                                XML✓OAS2,OAS3
                                PROTOBUF✗ToolingExtension
                                Custom✗OAS2,OAS3
                                Edit this page
                                Last updated on by Jim Schubert
                                - + - + - + diff --git a/docs/generators/cpp-pistache-server/index.html b/docs/generators/cpp-pistache-server/index.html index 834fccef2b8..7abe20d4222 100644 --- a/docs/generators/cpp-pistache-server/index.html +++ b/docs/generators/cpp-pistache-server/index.html @@ -21,26 +21,26 @@ - +
                                -

                                Config Options for cpp-pistache-server

                                OptionDescriptionValuesDefault
                                addExternalLibsAdd the Possibility to fetch and compile external Libraries needed by this Framework.true
                                helpersPackageSpecify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).org.openapitools.server.helpers
                                useStructModelUse struct-based model template instead of get/set-based model templatefalse

                                IMPORT MAPPING

                                Type/AliasImports
                                Object#include "Object.h"
                                std::map#include <map>
                                std::string#include <string>
                                std::vector#include <vector>

                                INSTANTIATION TYPES

                                Type/AliasInstantiated By

                                LANGUAGE PRIMITIVES

                                • bool
                                • char
                                • double
                                • float
                                • int
                                • int32_t
                                • int64_t
                                • long

                                RESERVED WORDS

                                  FEATURE SET

                                  Client Modification Feature

                                  NameSupportedDefined By
                                  BasePath✗ToolingExtension
                                  Authorizations✗ToolingExtension
                                  UserAgent✗ToolingExtension

                                  Data Type Feature

                                  NameSupportedDefined By
                                  Custom✗OAS2,OAS3
                                  Int32✓OAS2,OAS3
                                  Int64✓OAS2,OAS3
                                  Float✓OAS2,OAS3
                                  Double✓OAS2,OAS3
                                  Decimal✓ToolingExtension
                                  String✓OAS2,OAS3
                                  Byte✓OAS2,OAS3
                                  Binary✓OAS2,OAS3
                                  Boolean✓OAS2,OAS3
                                  Date✓OAS2,OAS3
                                  DateTime✓OAS2,OAS3
                                  Password✓OAS2,OAS3
                                  File✓OAS2
                                  Array✓OAS2,OAS3
                                  Maps✓ToolingExtension
                                  CollectionFormat✓OAS2
                                  CollectionFormatMulti✓OAS2
                                  Enum✓OAS2,OAS3
                                  ArrayOfEnum✓ToolingExtension
                                  ArrayOfModel✓ToolingExtension
                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                  ArrayOfCollectionOfModel✓ToolingExtension
                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                  MapOfEnum✓ToolingExtension
                                  MapOfModel✓ToolingExtension
                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                  MapOfCollectionOfModel✓ToolingExtension
                                  MapOfCollectionOfEnum✓ToolingExtension

                                  Documentation Feature

                                  NameSupportedDefined By
                                  Readme✓ToolingExtension
                                  Model✓ToolingExtension
                                  Api✓ToolingExtension

                                  Global Feature

                                  NameSupportedDefined By
                                  Host✓OAS2,OAS3
                                  BasePath✓OAS2,OAS3
                                  Info✓OAS2,OAS3
                                  Schemes✗OAS2,OAS3
                                  PartialSchemes✓OAS2,OAS3
                                  Consumes✓OAS2
                                  Produces✓OAS2
                                  ExternalDocumentation✓OAS2,OAS3
                                  Examples✓OAS2,OAS3
                                  XMLStructureDefinitions✗OAS2,OAS3
                                  MultiServer✗OAS3
                                  ParameterizedServer✗OAS3
                                  ParameterStyling✗OAS3
                                  Callbacks✗OAS3
                                  LinkObjects✗OAS3

                                  Parameter Feature

                                  NameSupportedDefined By
                                  Path✓OAS2,OAS3
                                  Query✓OAS2,OAS3
                                  Header✓OAS2,OAS3
                                  Body✓OAS2
                                  FormUnencoded✓OAS2
                                  FormMultipart✓OAS2
                                  Cookie✗OAS3

                                  Schema Support Feature

                                  NameSupportedDefined By
                                  Simple✓OAS2,OAS3
                                  Composite✓OAS2,OAS3
                                  Polymorphism✗OAS2,OAS3
                                  Union✗OAS3

                                  Security Feature

                                  NameSupportedDefined By
                                  BasicAuth✗OAS2,OAS3
                                  ApiKey✗OAS2,OAS3
                                  OpenIDConnect✗OAS3
                                  BearerToken✗OAS3
                                  OAuth2_Implicit✗OAS2,OAS3
                                  OAuth2_Password✗OAS2,OAS3
                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                  OAuth2_AuthorizationCode✗OAS2,OAS3

                                  Wire Format Feature

                                  NameSupportedDefined By
                                  JSON✓OAS2,OAS3
                                  XML✓OAS2,OAS3
                                  PROTOBUF✗ToolingExtension
                                  Custom✗OAS2,OAS3
                                  Edit this page
                                  Last updated on by Jim Schubert
                                  +

                                  Config Options for cpp-pistache-server

                                  OptionDescriptionValuesDefault
                                  addExternalLibsAdd the Possibility to fetch and compile external Libraries needed by this Framework.true
                                  helpersPackageSpecify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).org.openapitools.server.helpers
                                  useStructModelUse struct-based model template instead of get/set-based model templatefalse

                                  IMPORT MAPPING

                                  Type/AliasImports
                                  Object#include "Object.h"
                                  std::map#include <map>
                                  std::string#include <string>
                                  std::vector#include <vector>

                                  INSTANTIATION TYPES

                                  Type/AliasInstantiated By

                                  LANGUAGE PRIMITIVES

                                  • bool
                                  • char
                                  • double
                                  • float
                                  • int
                                  • int32_t
                                  • int64_t
                                  • long

                                  RESERVED WORDS

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✗OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/cpp-qt5-client/index.html b/docs/generators/cpp-qt5-client/index.html index 07a6af73be7..cb90d8cf7da 100644 --- a/docs/generators/cpp-qt5-client/index.html +++ b/docs/generators/cpp-qt5-client/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for cpp-qt5-client

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    contentCompressionEnable Compressed Content Encoding for requests and responsesfalse
                                    cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    modelNamePrefixPrefix that will be prepended to all model names.OAI
                                    optionalProjectFileGenerate client.pri.true
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    OAIHttpFileElement#include "OAIHttpFileElement.h"

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • QByteArray
                                    • QDate
                                    • QDateTime
                                    • QString
                                    • bool
                                    • double
                                    • float
                                    • qint32
                                    • qint64

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✗ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for cpp-qt5-client

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    contentCompressionEnable Compressed Content Encoding for requests and responsesfalse
                                    cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    modelNamePrefixPrefix that will be prepended to all model names.OAI
                                    optionalProjectFileGenerate client.pri.true
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    OAIHttpFileElement#include "OAIHttpFileElement.h"

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • QByteArray
                                    • QDate
                                    • QDateTime
                                    • QString
                                    • bool
                                    • double
                                    • float
                                    • qint32
                                    • qint64

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✗ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/cpp-qt5-qhttpengine-server/index.html b/docs/generators/cpp-qt5-qhttpengine-server/index.html index 5afa9473f9d..801851f6e13 100644 --- a/docs/generators/cpp-qt5-qhttpengine-server/index.html +++ b/docs/generators/cpp-qt5-qhttpengine-server/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for cpp-qt5-qhttpengine-server

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    contentCompressionEnable Compressed Content Encoding for requests and responsesfalse
                                    cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    modelNamePrefixPrefix that will be prepended to all model names.OAI
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    OAIHttpFileElement#include "OAIHttpFileElement.h"

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • QByteArray
                                    • QDate
                                    • QDateTime
                                    • QString
                                    • bool
                                    • double
                                    • float
                                    • qint32
                                    • qint64

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for cpp-qt5-qhttpengine-server

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    contentCompressionEnable Compressed Content Encoding for requests and responsesfalse
                                    cppNamespaceC++ namespace (convention: name::space::for::api).OpenAPI
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    modelNamePrefixPrefix that will be prepended to all model names.OAI
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    OAIHttpFileElement#include "OAIHttpFileElement.h"

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • QByteArray
                                    • QDate
                                    • QDateTime
                                    • QString
                                    • bool
                                    • double
                                    • float
                                    • qint32
                                    • qint64

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/cpp-restbed-server/index.html b/docs/generators/cpp-restbed-server/index.html index 049c26d079f..be073ccb103 100644 --- a/docs/generators/cpp-restbed-server/index.html +++ b/docs/generators/cpp-restbed-server/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for cpp-restbed-server

                                    OptionDescriptionValuesDefault
                                    apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.server.api
                                    declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                                    defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                                    modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.server.model
                                    packageVersionC++ package version.1.0.0

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    Object#include "Object.h"
                                    restbed::Bytes#include <corvusoft/restbed/byte.hpp>
                                    std::map#include <map>
                                    std::string#include <string>
                                    std::vector#include <vector>

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • bool
                                    • char
                                    • double
                                    • float
                                    • int
                                    • int32_t
                                    • int64_t
                                    • long

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✗OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for cpp-restbed-server

                                    OptionDescriptionValuesDefault
                                    apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.server.api
                                    declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                                    defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                                    modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.server.model
                                    packageVersionC++ package version.1.0.0

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    Object#include "Object.h"
                                    restbed::Bytes#include <corvusoft/restbed/byte.hpp>
                                    std::map#include <map>
                                    std::string#include <string>
                                    std::vector#include <vector>

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • bool
                                    • char
                                    • double
                                    • float
                                    • int
                                    • int32_t
                                    • int64_t
                                    • long

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✗OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/cpp-restsdk/index.html b/docs/generators/cpp-restsdk/index.html index a2fb4d00bf4..38c6ede6f8a 100644 --- a/docs/generators/cpp-restsdk/index.html +++ b/docs/generators/cpp-restsdk/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for cpp-restsdk

                                    OptionDescriptionValuesDefault
                                    apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.client.api
                                    declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                                    defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                                    generateGMocksForApisGenerate Google Mock classes for APIs.null
                                    modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.client.model
                                    packageVersionC++ package version.1.0.0

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    HttpContent#include "HttpContent.h"
                                    Object#include "Object.h"
                                    std::map#include <map>
                                    std::string#include <string>
                                    std::vector#include <vector>
                                    utility::datetime#include <cpprest/details/basic_types.h>
                                    utility::string_t#include <cpprest/details/basic_types.h>

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • bool
                                    • char
                                    • double
                                    • float
                                    • int
                                    • int32_t
                                    • int64_t
                                    • long

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for cpp-restsdk

                                    OptionDescriptionValuesDefault
                                    apiPackageC++ namespace for apis (convention: name.space.api).org.openapitools.client.api
                                    declspecC++ preprocessor to place before the class name for handling dllexport/dllimport.
                                    defaultIncludeThe default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"
                                    generateGMocksForApisGenerate Google Mock classes for APIs.null
                                    modelPackageC++ namespace for models (convention: name.space.model).org.openapitools.client.model
                                    packageVersionC++ package version.1.0.0

                                    IMPORT MAPPING

                                    Type/AliasImports
                                    HttpContent#include "HttpContent.h"
                                    Object#include "Object.h"
                                    std::map#include <map>
                                    std::string#include <string>
                                    std::vector#include <vector>
                                    utility::datetime#include <cpprest/details/basic_types.h>
                                    utility::string_t#include <cpprest/details/basic_types.h>

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • bool
                                    • char
                                    • double
                                    • float
                                    • int
                                    • int32_t
                                    • int64_t
                                    • long

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • inline
                                    • int
                                    • linux
                                    • long
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/cpp-tizen/index.html b/docs/generators/cpp-tizen/index.html index fc3e52b2c4a..b23a40d6939 100644 --- a/docs/generators/cpp-tizen/index.html +++ b/docs/generators/cpp-tizen/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for cpp-tizen

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • bool
                                    • double
                                    • float
                                    • int
                                    • long long
                                    • std::string

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • atomic_cancel
                                    • atomic_commit
                                    • atomic_noexcept
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • import
                                    • inline
                                    • int
                                    • long
                                    • module
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • synchronized
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✗OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✓OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for cpp-tizen

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                    • bool
                                    • double
                                    • float
                                    • int
                                    • long long
                                    • std::string

                                    RESERVED WORDS

                                    • alignas
                                    • alignof
                                    • and
                                    • and_eq
                                    • asm
                                    • atomic_cancel
                                    • atomic_commit
                                    • atomic_noexcept
                                    • auto
                                    • bitand
                                    • bitor
                                    • bool
                                    • break
                                    • case
                                    • catch
                                    • char
                                    • char16_t
                                    • char32_t
                                    • class
                                    • compl
                                    • concept
                                    • const
                                    • const_cast
                                    • constexpr
                                    • continue
                                    • decltype
                                    • default
                                    • delete
                                    • do
                                    • double
                                    • dynamic_cast
                                    • else
                                    • enum
                                    • explicit
                                    • export
                                    • extern
                                    • false
                                    • float
                                    • for
                                    • friend
                                    • goto
                                    • if
                                    • import
                                    • inline
                                    • int
                                    • long
                                    • module
                                    • mutable
                                    • namespace
                                    • new
                                    • noexcept
                                    • not
                                    • not_eq
                                    • nullptr
                                    • operator
                                    • or
                                    • or_eq
                                    • private
                                    • protected
                                    • public
                                    • register
                                    • reinterpret_cast
                                    • requires
                                    • return
                                    • short
                                    • signed
                                    • sizeof
                                    • static
                                    • static_assert
                                    • static_cast
                                    • struct
                                    • switch
                                    • synchronized
                                    • template
                                    • this
                                    • thread_local
                                    • throw
                                    • true
                                    • try
                                    • typedef
                                    • typeid
                                    • typename
                                    • union
                                    • unsigned
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • wchar_t
                                    • while
                                    • xor
                                    • xor_eq

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✗OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✓OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/csharp-dotnet2/index.html b/docs/generators/csharp-dotnet2/index.html index ce6d6dd73b4..89a02266b16 100644 --- a/docs/generators/csharp-dotnet2/index.html +++ b/docs/generators/csharp-dotnet2/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for csharp-dotnet2

                                    OptionDescriptionValuesDefault
                                    clientPackageC# client package name (convention: Camel.Case).Org.OpenAPITools.Client
                                    packageNameC# package name (convention: Camel.Case).Org.OpenAPITools
                                    packageVersionC# package version.1.0.0

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • Client
                                    • abstract
                                    • as
                                    • base
                                    • bool
                                    • break
                                    • byte
                                    • case
                                    • catch
                                    • char
                                    • checked
                                    • class
                                    • client
                                    • const
                                    • continue
                                    • decimal
                                    • default
                                    • delegate
                                    • do
                                    • double
                                    • else
                                    • enum
                                    • event
                                    • explicit
                                    • extern
                                    • false
                                    • finally
                                    • fixed
                                    • float
                                    • for
                                    • foreach
                                    • goto
                                    • if
                                    • implicit
                                    • in
                                    • int
                                    • interface
                                    • internal
                                    • is
                                    • localVarFileParams
                                    • localVarFormParams
                                    • localVarHeaderParams
                                    • localVarHttpContentType
                                    • localVarHttpContentTypes
                                    • localVarHttpHeaderAccept
                                    • localVarHttpHeaderAccepts
                                    • localVarPath
                                    • localVarPathParams
                                    • localVarPostBody
                                    • localVarQueryParams
                                    • localVarResponse
                                    • localVarStatusCode
                                    • lock
                                    • long
                                    • namespace
                                    • new
                                    • null
                                    • object
                                    • operator
                                    • out
                                    • override
                                    • parameter
                                    • params
                                    • private
                                    • protected
                                    • public
                                    • readonly
                                    • ref
                                    • return
                                    • sbyte
                                    • sealed
                                    • short
                                    • sizeof
                                    • stackalloc
                                    • static
                                    • string
                                    • struct
                                    • switch
                                    • this
                                    • throw
                                    • true
                                    • try
                                    • typeof
                                    • uint
                                    • ulong
                                    • unchecked
                                    • unsafe
                                    • ushort
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • while

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✓OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✓OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✓OAS2,OAS3
                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                    OAuth2_AuthorizationCode✓OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for csharp-dotnet2

                                    OptionDescriptionValuesDefault
                                    clientPackageC# client package name (convention: Camel.Case).Org.OpenAPITools.Client
                                    packageNameC# package name (convention: Camel.Case).Org.OpenAPITools
                                    packageVersionC# package version.1.0.0

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • Client
                                    • abstract
                                    • as
                                    • base
                                    • bool
                                    • break
                                    • byte
                                    • case
                                    • catch
                                    • char
                                    • checked
                                    • class
                                    • client
                                    • const
                                    • continue
                                    • decimal
                                    • default
                                    • delegate
                                    • do
                                    • double
                                    • else
                                    • enum
                                    • event
                                    • explicit
                                    • extern
                                    • false
                                    • finally
                                    • fixed
                                    • float
                                    • for
                                    • foreach
                                    • goto
                                    • if
                                    • implicit
                                    • in
                                    • int
                                    • interface
                                    • internal
                                    • is
                                    • localVarFileParams
                                    • localVarFormParams
                                    • localVarHeaderParams
                                    • localVarHttpContentType
                                    • localVarHttpContentTypes
                                    • localVarHttpHeaderAccept
                                    • localVarHttpHeaderAccepts
                                    • localVarPath
                                    • localVarPathParams
                                    • localVarPostBody
                                    • localVarQueryParams
                                    • localVarResponse
                                    • localVarStatusCode
                                    • lock
                                    • long
                                    • namespace
                                    • new
                                    • null
                                    • object
                                    • operator
                                    • out
                                    • override
                                    • parameter
                                    • params
                                    • private
                                    • protected
                                    • public
                                    • readonly
                                    • ref
                                    • return
                                    • sbyte
                                    • sealed
                                    • short
                                    • sizeof
                                    • stackalloc
                                    • static
                                    • string
                                    • struct
                                    • switch
                                    • this
                                    • throw
                                    • true
                                    • try
                                    • typeof
                                    • uint
                                    • ulong
                                    • unchecked
                                    • unsafe
                                    • ushort
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • while

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✓OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✓OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✓OAS2,OAS3
                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                    OAuth2_AuthorizationCode✓OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/csharp-nancyfx/index.html b/docs/generators/csharp-nancyfx/index.html index 7651f7e2b2a..15995aa1416 100644 --- a/docs/generators/csharp-nancyfx/index.html +++ b/docs/generators/csharp-nancyfx/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for csharp-nancyfx

                                    OptionDescriptionValuesDefault
                                    asyncServerSet to true to enable the generation of async routes/endpoints.false
                                    immutableEnabled by default. If disabled generates model classes with setterstrue
                                    interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.
                                    optionalProjectFileGenerate {PackageName}.csproj.true
                                    packageContextOptionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.null
                                    packageGuidThe GUID that will be associated with the C# projectnull
                                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                                    packageVersionC# package version.1.0.0
                                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                    sourceFoldersource folder for generated codesrc
                                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                    writeModulePathEnabled by default. If disabled, module paths will not mirror api base pathtrue

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • LocalDate?
                                    • LocalTime?
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • ZonedDateTime?
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • async
                                    • await
                                    • dynamic
                                    • var
                                    • yield

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✗ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for csharp-nancyfx

                                    OptionDescriptionValuesDefault
                                    asyncServerSet to true to enable the generation of async routes/endpoints.false
                                    immutableEnabled by default. If disabled generates model classes with setterstrue
                                    interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.
                                    optionalProjectFileGenerate {PackageName}.csproj.true
                                    packageContextOptionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.null
                                    packageGuidThe GUID that will be associated with the C# projectnull
                                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                                    packageVersionC# package version.1.0.0
                                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                    sourceFoldersource folder for generated codesrc
                                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                    writeModulePathEnabled by default. If disabled, module paths will not mirror api base pathtrue

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • LocalDate?
                                    • LocalTime?
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • ZonedDateTime?
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • async
                                    • await
                                    • dynamic
                                    • var
                                    • yield

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✗ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✗ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✗ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✗OAS2,OAS3
                                    ApiKey✗OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✗OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/csharp-netcore/index.html b/docs/generators/csharp-netcore/index.html index 100cb4da4e3..49f561f5753 100644 --- a/docs/generators/csharp-netcore/index.html +++ b/docs/generators/csharp-netcore/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for csharp-netcore

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    caseInsensitiveResponseHeadersMake API response's headers case-insensitivefalse
                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                    interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.I
                                    licenseIdThe identifier of the licensenull
                                    modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namePascalCase
                                    netCoreProjectFileUse the new format (.NET Core) for .NET project files (.csproj).false
                                    nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.false
                                    optionalAssemblyInfoGenerate AssemblyInfo.cs.true
                                    optionalEmitDefaultValuesSet DataMember's EmitDefaultValue.false
                                    optionalMethodArgumentC# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).true
                                    optionalProjectFileGenerate {PackageName}.csproj.true
                                    packageGuidThe GUID that will be associated with the C# projectnull
                                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                                    packageTagsTags to identify the packagenull
                                    packageVersionC# package version.1.0.0
                                    releaseNoteRelease note, default to 'Minor update'.Minor update
                                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                    sourceFoldersource folder for generated codesrc
                                    targetFrameworkThe target .NET framework version.
                                    netstandard1.3
                                    .NET Standard 1.3 compatible
                                    netstandard1.4
                                    .NET Standard 1.4 compatible
                                    netstandard1.5
                                    .NET Standard 1.5 compatible
                                    netstandard1.6
                                    .NET Standard 1.6 compatible
                                    netstandard2.0
                                    .NET Standard 2.0 compatible
                                    netstandard2.1
                                    .NET Standard 2.1 compatible
                                    netcoreapp2.0
                                    .NET Core 2.0 compatible
                                    netcoreapp2.1
                                    .NET Core 2.1 compatible
                                    netcoreapp3.0
                                    .NET Core 3.0 compatible
                                    netcoreapp3.1
                                    .NET Core 3.1 compatible
                                    		netstandard2.0
                                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                    validatableGenerates self-validatable models.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • Client
                                    • abstract
                                    • as
                                    • base
                                    • bool
                                    • break
                                    • byte
                                    • case
                                    • catch
                                    • char
                                    • checked
                                    • class
                                    • client
                                    • const
                                    • continue
                                    • decimal
                                    • default
                                    • delegate
                                    • do
                                    • double
                                    • else
                                    • enum
                                    • event
                                    • explicit
                                    • extern
                                    • false
                                    • finally
                                    • fixed
                                    • float
                                    • for
                                    • foreach
                                    • goto
                                    • if
                                    • implicit
                                    • in
                                    • int
                                    • interface
                                    • internal
                                    • is
                                    • localVarFileParams
                                    • localVarFormParams
                                    • localVarHeaderParams
                                    • localVarHttpContentType
                                    • localVarHttpContentTypes
                                    • localVarHttpHeaderAccept
                                    • localVarHttpHeaderAccepts
                                    • localVarPath
                                    • localVarPathParams
                                    • localVarPostBody
                                    • localVarQueryParams
                                    • localVarResponse
                                    • localVarStatusCode
                                    • lock
                                    • long
                                    • namespace
                                    • new
                                    • null
                                    • object
                                    • operator
                                    • out
                                    • override
                                    • parameter
                                    • params
                                    • private
                                    • protected
                                    • public
                                    • readonly
                                    • ref
                                    • return
                                    • sbyte
                                    • sealed
                                    • short
                                    • sizeof
                                    • stackalloc
                                    • static
                                    • string
                                    • struct
                                    • switch
                                    • this
                                    • throw
                                    • true
                                    • try
                                    • typeof
                                    • uint
                                    • ulong
                                    • unchecked
                                    • unsafe
                                    • ushort
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • while

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✓ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✓ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for csharp-netcore

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    caseInsensitiveResponseHeadersMake API response's headers case-insensitivefalse
                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                    interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.I
                                    licenseIdThe identifier of the licensenull
                                    modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namePascalCase
                                    netCoreProjectFileUse the new format (.NET Core) for .NET project files (.csproj).false
                                    nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.false
                                    optionalAssemblyInfoGenerate AssemblyInfo.cs.true
                                    optionalEmitDefaultValuesSet DataMember's EmitDefaultValue.false
                                    optionalMethodArgumentC# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).true
                                    optionalProjectFileGenerate {PackageName}.csproj.true
                                    packageGuidThe GUID that will be associated with the C# projectnull
                                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                                    packageTagsTags to identify the packagenull
                                    packageVersionC# package version.1.0.0
                                    releaseNoteRelease note, default to 'Minor update'.Minor update
                                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                    sourceFoldersource folder for generated codesrc
                                    targetFrameworkThe target .NET framework version.
                                    netstandard1.3
                                    .NET Standard 1.3 compatible
                                    netstandard1.4
                                    .NET Standard 1.4 compatible
                                    netstandard1.5
                                    .NET Standard 1.5 compatible
                                    netstandard1.6
                                    .NET Standard 1.6 compatible
                                    netstandard2.0
                                    .NET Standard 2.0 compatible
                                    netstandard2.1
                                    .NET Standard 2.1 compatible
                                    netcoreapp2.0
                                    .NET Core 2.0 compatible
                                    netcoreapp2.1
                                    .NET Core 2.1 compatible
                                    netcoreapp3.0
                                    .NET Core 3.0 compatible
                                    netcoreapp3.1
                                    .NET Core 3.1 compatible
                                    		netstandard2.0
                                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                    validatableGenerates self-validatable models.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • Client
                                    • abstract
                                    • as
                                    • base
                                    • bool
                                    • break
                                    • byte
                                    • case
                                    • catch
                                    • char
                                    • checked
                                    • class
                                    • client
                                    • const
                                    • continue
                                    • decimal
                                    • default
                                    • delegate
                                    • do
                                    • double
                                    • else
                                    • enum
                                    • event
                                    • explicit
                                    • extern
                                    • false
                                    • finally
                                    • fixed
                                    • float
                                    • for
                                    • foreach
                                    • goto
                                    • if
                                    • implicit
                                    • in
                                    • int
                                    • interface
                                    • internal
                                    • is
                                    • localVarFileParams
                                    • localVarFormParams
                                    • localVarHeaderParams
                                    • localVarHttpContentType
                                    • localVarHttpContentTypes
                                    • localVarHttpHeaderAccept
                                    • localVarHttpHeaderAccepts
                                    • localVarPath
                                    • localVarPathParams
                                    • localVarPostBody
                                    • localVarQueryParams
                                    • localVarResponse
                                    • localVarStatusCode
                                    • lock
                                    • long
                                    • namespace
                                    • new
                                    • null
                                    • object
                                    • operator
                                    • out
                                    • override
                                    • parameter
                                    • params
                                    • private
                                    • protected
                                    • public
                                    • readonly
                                    • ref
                                    • return
                                    • sbyte
                                    • sealed
                                    • short
                                    • sizeof
                                    • stackalloc
                                    • static
                                    • string
                                    • struct
                                    • switch
                                    • this
                                    • throw
                                    • true
                                    • try
                                    • typeof
                                    • uint
                                    • ulong
                                    • unchecked
                                    • unsafe
                                    • ushort
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • while

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✓ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✓ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✓OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/csharp/index.html b/docs/generators/csharp/index.html index 64b7ae1b4f1..bbe8b8e66ba 100644 --- a/docs/generators/csharp/index.html +++ b/docs/generators/csharp/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for csharp

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    caseInsensitiveResponseHeadersMake API response's headers case-insensitivefalse
                                    generatePropertyChangedSpecifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.false
                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                    interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.I
                                    modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namePascalCase
                                    netCoreProjectFileUse the new format (.NET Core) for .NET project files (.csproj).false
                                    nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.false
                                    optionalAssemblyInfoGenerate AssemblyInfo.cs.true
                                    optionalEmitDefaultValuesSet DataMember's EmitDefaultValue.false
                                    optionalMethodArgumentC# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).true
                                    optionalProjectFileGenerate {PackageName}.csproj.true
                                    packageGuidThe GUID that will be associated with the C# projectnull
                                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                                    packageVersionC# package version.1.0.0
                                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                    sourceFoldersource folder for generated codesrc
                                    targetFrameworkThe 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 (DEPRECATED. Please use csharp-netcore generator instead)
                                    uwp
                                    Universal Windows Platform (DEPRECATED. Please use csharp-netcore generator instead)
                                    		v4.5
                                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                    useCompareNetObjectsUse KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.false
                                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                    validatableGenerates self-validatable models.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • Client
                                    • abstract
                                    • as
                                    • base
                                    • bool
                                    • break
                                    • byte
                                    • case
                                    • catch
                                    • char
                                    • checked
                                    • class
                                    • client
                                    • const
                                    • continue
                                    • decimal
                                    • default
                                    • delegate
                                    • do
                                    • double
                                    • else
                                    • enum
                                    • event
                                    • explicit
                                    • extern
                                    • false
                                    • finally
                                    • fixed
                                    • float
                                    • for
                                    • foreach
                                    • goto
                                    • if
                                    • implicit
                                    • in
                                    • int
                                    • interface
                                    • internal
                                    • is
                                    • localVarFileParams
                                    • localVarFormParams
                                    • localVarHeaderParams
                                    • localVarHttpContentType
                                    • localVarHttpContentTypes
                                    • localVarHttpHeaderAccept
                                    • localVarHttpHeaderAccepts
                                    • localVarPath
                                    • localVarPathParams
                                    • localVarPostBody
                                    • localVarQueryParams
                                    • localVarResponse
                                    • localVarStatusCode
                                    • lock
                                    • long
                                    • namespace
                                    • new
                                    • null
                                    • object
                                    • operator
                                    • out
                                    • override
                                    • parameter
                                    • params
                                    • private
                                    • protected
                                    • public
                                    • readonly
                                    • ref
                                    • return
                                    • sbyte
                                    • sealed
                                    • short
                                    • sizeof
                                    • stackalloc
                                    • static
                                    • string
                                    • struct
                                    • switch
                                    • this
                                    • throw
                                    • true
                                    • try
                                    • typeof
                                    • uint
                                    • ulong
                                    • unchecked
                                    • unsafe
                                    • ushort
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • while

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✓ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✓ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    +

                                    Config Options for csharp

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    caseInsensitiveResponseHeadersMake API response's headers case-insensitivefalse
                                    generatePropertyChangedSpecifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.false
                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                    interfacePrefixPrefix interfaces with a community standard or widely accepted prefix.I
                                    modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namePascalCase
                                    netCoreProjectFileUse the new format (.NET Core) for .NET project files (.csproj).false
                                    nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.false
                                    optionalAssemblyInfoGenerate AssemblyInfo.cs.true
                                    optionalEmitDefaultValuesSet DataMember's EmitDefaultValue.false
                                    optionalMethodArgumentC# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).true
                                    optionalProjectFileGenerate {PackageName}.csproj.true
                                    packageGuidThe GUID that will be associated with the C# projectnull
                                    packageNameC# package name (convention: Title.Case).Org.OpenAPITools
                                    packageVersionC# package version.1.0.0
                                    returnICollectionReturn ICollection<T> instead of the concrete type.false
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                    sourceFoldersource folder for generated codesrc
                                    targetFrameworkThe 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 (DEPRECATED. Please use csharp-netcore generator instead)
                                    uwp
                                    Universal Windows Platform (DEPRECATED. Please use csharp-netcore generator instead)
                                    		v4.5
                                    useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                    useCompareNetObjectsUse KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.false
                                    useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                    validatableGenerates self-validatable models.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By
                                    arrayList
                                    listList
                                    mapDictionary

                                    LANGUAGE PRIMITIVES

                                    • Boolean
                                    • Collection
                                    • DateTime
                                    • DateTime?
                                    • DateTimeOffset
                                    • DateTimeOffset?
                                    • Dictionary
                                    • Double
                                    • Float
                                    • Guid
                                    • Guid?
                                    • ICollection
                                    • Int32
                                    • Int64
                                    • List
                                    • Object
                                    • String
                                    • System.IO.Stream
                                    • bool
                                    • bool?
                                    • byte[]
                                    • decimal
                                    • decimal?
                                    • double
                                    • double?
                                    • float
                                    • float?
                                    • int
                                    • int?
                                    • long
                                    • long?
                                    • string

                                    RESERVED WORDS

                                    • Client
                                    • abstract
                                    • as
                                    • base
                                    • bool
                                    • break
                                    • byte
                                    • case
                                    • catch
                                    • char
                                    • checked
                                    • class
                                    • client
                                    • const
                                    • continue
                                    • decimal
                                    • default
                                    • delegate
                                    • do
                                    • double
                                    • else
                                    • enum
                                    • event
                                    • explicit
                                    • extern
                                    • false
                                    • finally
                                    • fixed
                                    • float
                                    • for
                                    • foreach
                                    • goto
                                    • if
                                    • implicit
                                    • in
                                    • int
                                    • interface
                                    • internal
                                    • is
                                    • localVarFileParams
                                    • localVarFormParams
                                    • localVarHeaderParams
                                    • localVarHttpContentType
                                    • localVarHttpContentTypes
                                    • localVarHttpHeaderAccept
                                    • localVarHttpHeaderAccepts
                                    • localVarPath
                                    • localVarPathParams
                                    • localVarPostBody
                                    • localVarQueryParams
                                    • localVarResponse
                                    • localVarStatusCode
                                    • lock
                                    • long
                                    • namespace
                                    • new
                                    • null
                                    • object
                                    • operator
                                    • out
                                    • override
                                    • parameter
                                    • params
                                    • private
                                    • protected
                                    • public
                                    • readonly
                                    • ref
                                    • return
                                    • sbyte
                                    • sealed
                                    • short
                                    • sizeof
                                    • stackalloc
                                    • static
                                    • string
                                    • struct
                                    • switch
                                    • this
                                    • throw
                                    • true
                                    • try
                                    • typeof
                                    • uint
                                    • ulong
                                    • unchecked
                                    • unsafe
                                    • ushort
                                    • using
                                    • virtual
                                    • void
                                    • volatile
                                    • while

                                    FEATURE SET

                                    Client Modification Feature

                                    NameSupportedDefined By
                                    BasePath✓ToolingExtension
                                    Authorizations✗ToolingExtension
                                    UserAgent✓ToolingExtension

                                    Data Type Feature

                                    NameSupportedDefined By
                                    Custom✗OAS2,OAS3
                                    Int32✓OAS2,OAS3
                                    Int64✓OAS2,OAS3
                                    Float✓OAS2,OAS3
                                    Double✓OAS2,OAS3
                                    Decimal✓ToolingExtension
                                    String✓OAS2,OAS3
                                    Byte✓OAS2,OAS3
                                    Binary✓OAS2,OAS3
                                    Boolean✓OAS2,OAS3
                                    Date✓OAS2,OAS3
                                    DateTime✓OAS2,OAS3
                                    Password✓OAS2,OAS3
                                    File✓OAS2
                                    Array✓OAS2,OAS3
                                    Maps✓ToolingExtension
                                    CollectionFormat✓OAS2
                                    CollectionFormatMulti✓OAS2
                                    Enum✓OAS2,OAS3
                                    ArrayOfEnum✓ToolingExtension
                                    ArrayOfModel✓ToolingExtension
                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                    ArrayOfCollectionOfModel✓ToolingExtension
                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                    MapOfEnum✓ToolingExtension
                                    MapOfModel✓ToolingExtension
                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                    MapOfCollectionOfModel✓ToolingExtension
                                    MapOfCollectionOfEnum✓ToolingExtension

                                    Documentation Feature

                                    NameSupportedDefined By
                                    Readme✓ToolingExtension
                                    Model✓ToolingExtension
                                    Api✓ToolingExtension

                                    Global Feature

                                    NameSupportedDefined By
                                    Host✓OAS2,OAS3
                                    BasePath✓OAS2,OAS3
                                    Info✓OAS2,OAS3
                                    Schemes✗OAS2,OAS3
                                    PartialSchemes✓OAS2,OAS3
                                    Consumes✓OAS2
                                    Produces✓OAS2
                                    ExternalDocumentation✓OAS2,OAS3
                                    Examples✓OAS2,OAS3
                                    XMLStructureDefinitions✗OAS2,OAS3
                                    MultiServer✗OAS3
                                    ParameterizedServer✗OAS3
                                    ParameterStyling✗OAS3
                                    Callbacks✗OAS3
                                    LinkObjects✗OAS3

                                    Parameter Feature

                                    NameSupportedDefined By
                                    Path✓OAS2,OAS3
                                    Query✓OAS2,OAS3
                                    Header✓OAS2,OAS3
                                    Body✓OAS2
                                    FormUnencoded✓OAS2
                                    FormMultipart✓OAS2
                                    Cookie✗OAS3

                                    Schema Support Feature

                                    NameSupportedDefined By
                                    Simple✓OAS2,OAS3
                                    Composite✓OAS2,OAS3
                                    Polymorphism✓OAS2,OAS3
                                    Union✗OAS3

                                    Security Feature

                                    NameSupportedDefined By
                                    BasicAuth✓OAS2,OAS3
                                    ApiKey✓OAS2,OAS3
                                    OpenIDConnect✗OAS3
                                    BearerToken✗OAS3
                                    OAuth2_Implicit✓OAS2,OAS3
                                    OAuth2_Password✗OAS2,OAS3
                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                    Wire Format Feature

                                    NameSupportedDefined By
                                    JSON✓OAS2,OAS3
                                    XML✓OAS2,OAS3
                                    PROTOBUF✗ToolingExtension
                                    Custom✗OAS2,OAS3
                                    Edit this page
                                    Last updated on by Jim Schubert
                                    - + - + - + diff --git a/docs/generators/cwiki/index.html b/docs/generators/cwiki/index.html index ed4d831523a..bc768eb0151 100644 --- a/docs/generators/cwiki/index.html +++ b/docs/generators/cwiki/index.html @@ -21,26 +21,26 @@ - +
                                    -

                                    Config Options for cwiki

                                    OptionDescriptionValuesDefault
                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                    appDescriptiondescription of the applicationnull
                                    appNameshort name of the applicationnull
                                    artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                    artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                    groupIdgroupId in generated pom.xmlnull
                                    infoEmailan email address to contact for inquiries about the applicationnull
                                    infoUrla URL where users can get more information about the applicationnull
                                    invokerPackageroot package for generated codenull
                                    licenseInfoa short description of the licensenull
                                    licenseUrla URL pointing to the full licensenull
                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                    IMPORT MAPPING

                                    Type/AliasImports

                                    INSTANTIATION TYPES

                                    Type/AliasInstantiated By

                                    LANGUAGE PRIMITIVES

                                      RESERVED WORDS

                                        FEATURE SET

                                        Client Modification Feature

                                        NameSupportedDefined By
                                        BasePath✗ToolingExtension
                                        Authorizations✗ToolingExtension
                                        UserAgent✗ToolingExtension

                                        Data Type Feature

                                        NameSupportedDefined By
                                        Custom✗OAS2,OAS3
                                        Int32✓OAS2,OAS3
                                        Int64✓OAS2,OAS3
                                        Float✓OAS2,OAS3
                                        Double✓OAS2,OAS3
                                        Decimal✓ToolingExtension
                                        String✓OAS2,OAS3
                                        Byte✓OAS2,OAS3
                                        Binary✓OAS2,OAS3
                                        Boolean✓OAS2,OAS3
                                        Date✓OAS2,OAS3
                                        DateTime✓OAS2,OAS3
                                        Password✓OAS2,OAS3
                                        File✓OAS2
                                        Array✓OAS2,OAS3
                                        Maps✓ToolingExtension
                                        CollectionFormat✓OAS2
                                        CollectionFormatMulti✓OAS2
                                        Enum✓OAS2,OAS3
                                        ArrayOfEnum✓ToolingExtension
                                        ArrayOfModel✓ToolingExtension
                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                        ArrayOfCollectionOfModel✓ToolingExtension
                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                        MapOfEnum✓ToolingExtension
                                        MapOfModel✓ToolingExtension
                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                        MapOfCollectionOfModel✓ToolingExtension
                                        MapOfCollectionOfEnum✓ToolingExtension

                                        Documentation Feature

                                        NameSupportedDefined By
                                        Readme✗ToolingExtension
                                        Model✗ToolingExtension
                                        Api✗ToolingExtension

                                        Global Feature

                                        NameSupportedDefined By
                                        Host✓OAS2,OAS3
                                        BasePath✓OAS2,OAS3
                                        Info✓OAS2,OAS3
                                        Schemes✗OAS2,OAS3
                                        PartialSchemes✓OAS2,OAS3
                                        Consumes✓OAS2
                                        Produces✓OAS2
                                        ExternalDocumentation✓OAS2,OAS3
                                        Examples✓OAS2,OAS3
                                        XMLStructureDefinitions✗OAS2,OAS3
                                        MultiServer✗OAS3
                                        ParameterizedServer✗OAS3
                                        ParameterStyling✗OAS3
                                        Callbacks✓OAS3
                                        LinkObjects✗OAS3

                                        Parameter Feature

                                        NameSupportedDefined By
                                        Path✓OAS2,OAS3
                                        Query✓OAS2,OAS3
                                        Header✓OAS2,OAS3
                                        Body✓OAS2
                                        FormUnencoded✓OAS2
                                        FormMultipart✓OAS2
                                        Cookie✗OAS3

                                        Schema Support Feature

                                        NameSupportedDefined By
                                        Simple✓OAS2,OAS3
                                        Composite✓OAS2,OAS3
                                        Polymorphism✗OAS2,OAS3
                                        Union✗OAS3

                                        Security Feature

                                        NameSupportedDefined By
                                        BasicAuth✗OAS2,OAS3
                                        ApiKey✗OAS2,OAS3
                                        OpenIDConnect✗OAS3
                                        BearerToken✗OAS3
                                        OAuth2_Implicit✗OAS2,OAS3
                                        OAuth2_Password✗OAS2,OAS3
                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                        Wire Format Feature

                                        NameSupportedDefined By
                                        JSON✓OAS2,OAS3
                                        XML✓OAS2,OAS3
                                        PROTOBUF✗ToolingExtension
                                        Custom✓OAS2,OAS3
                                        Edit this page
                                        Last updated on by Jim Schubert
                                        +

                                        Config Options for cwiki

                                        OptionDescriptionValuesDefault
                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                        appDescriptiondescription of the applicationnull
                                        appNameshort name of the applicationnull
                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                        groupIdgroupId in generated pom.xmlnull
                                        infoEmailan email address to contact for inquiries about the applicationnull
                                        infoUrla URL where users can get more information about the applicationnull
                                        invokerPackageroot package for generated codenull
                                        licenseInfoa short description of the licensenull
                                        licenseUrla URL pointing to the full licensenull
                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                        IMPORT MAPPING

                                        Type/AliasImports

                                        INSTANTIATION TYPES

                                        Type/AliasInstantiated By

                                        LANGUAGE PRIMITIVES

                                          RESERVED WORDS

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✗ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✗ToolingExtension
                                            Model✗ToolingExtension
                                            Api✗ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✓OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✗OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✗OAS2,OAS3
                                            ApiKey✗OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✗OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✓OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            - + - + - + diff --git a/docs/generators/dart-dio/index.html b/docs/generators/dart-dio/index.html index 0f38aa74a1a..83a21e69516 100644 --- a/docs/generators/dart-dio/index.html +++ b/docs/generators/dart-dio/index.html @@ -21,26 +21,26 @@ - +
                                            -

                                            Config Options for dart-dio

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            browserClientIs the client browser based (for Dart 1.x only)null
                                            dateLibraryOption. Date library to use
                                            core
                                            Dart core library (DateTime)
                                            timemachine
                                            Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.
                                            		core
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            nullableFieldsIs the null fields should be in the JSON payloadnull
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            pubAuthorAuthor name in generated pubspecnull
                                            pubAuthorEmailEmail address of the author in generated pubspecnull
                                            pubDescriptionDescription in generated pubspecnull
                                            pubHomepageHomepage in generated pubspecnull
                                            pubNameName in generated pubspecnull
                                            pubVersionVersion in generated pubspecnull
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                            sourceFolderSource folder for generated codenull
                                            supportDart2Support Dart 2.x (Dart 1.x support has been deprecated)true
                                            useEnumExtensionAllow the 'x-enum-values' extension for enumsnull

                                            IMPORT MAPPING

                                            Type/AliasImports
                                            BuiltListpackage:built_collection/built_collection.dart
                                            BuiltMappackage:built_collection/built_collection.dart
                                            JsonObjectpackage:built_value/json_object.dart
                                            Uint8Listdart:typed_data

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayList
                                            mapMap

                                            LANGUAGE PRIMITIVES

                                            • String
                                            • bool
                                            • double
                                            • int
                                            • num

                                            RESERVED WORDS

                                            • abstract
                                            • as
                                            • assert
                                            • async
                                            • await
                                            • break
                                            • case
                                            • catch
                                            • class
                                            • const
                                            • continue
                                            • covariant
                                            • default
                                            • deferred
                                            • do
                                            • dynamic
                                            • else
                                            • enum
                                            • export
                                            • extends
                                            • extension
                                            • external
                                            • factory
                                            • false
                                            • final
                                            • finally
                                            • for
                                            • function
                                            • get
                                            • hide
                                            • if
                                            • implements
                                            • import
                                            • in
                                            • inout
                                            • interface
                                            • is
                                            • late
                                            • library
                                            • mixin
                                            • native
                                            • new
                                            • null
                                            • of
                                            • on
                                            • operator
                                            • out
                                            • part
                                            • patch
                                            • required
                                            • rethrow
                                            • return
                                            • set
                                            • show
                                            • source
                                            • static
                                            • super
                                            • switch
                                            • sync
                                            • this
                                            • throw
                                            • true
                                            • try
                                            • typedef
                                            • var
                                            • void
                                            • while
                                            • with
                                            • yield

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✓ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✓ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✗OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            +

                                            Config Options for dart-dio

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            browserClientIs the client browser based (for Dart 1.x only)null
                                            dateLibraryOption. Date library to use
                                            core
                                            Dart core library (DateTime)
                                            timemachine
                                            Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.
                                            		core
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            nullableFieldsIs the null fields should be in the JSON payloadnull
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            pubAuthorAuthor name in generated pubspecnull
                                            pubAuthorEmailEmail address of the author in generated pubspecnull
                                            pubDescriptionDescription in generated pubspecnull
                                            pubHomepageHomepage in generated pubspecnull
                                            pubNameName in generated pubspecnull
                                            pubVersionVersion in generated pubspecnull
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                            sourceFolderSource folder for generated codenull
                                            supportDart2Support Dart 2.x (Dart 1.x support has been deprecated)true
                                            useEnumExtensionAllow the 'x-enum-values' extension for enumsnull

                                            IMPORT MAPPING

                                            Type/AliasImports
                                            BuiltListpackage:built_collection/built_collection.dart
                                            BuiltMappackage:built_collection/built_collection.dart
                                            JsonObjectpackage:built_value/json_object.dart
                                            Uint8Listdart:typed_data

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayList
                                            mapMap

                                            LANGUAGE PRIMITIVES

                                            • String
                                            • bool
                                            • double
                                            • int
                                            • num

                                            RESERVED WORDS

                                            • abstract
                                            • as
                                            • assert
                                            • async
                                            • await
                                            • break
                                            • case
                                            • catch
                                            • class
                                            • const
                                            • continue
                                            • covariant
                                            • default
                                            • deferred
                                            • do
                                            • dynamic
                                            • else
                                            • enum
                                            • export
                                            • extends
                                            • extension
                                            • external
                                            • factory
                                            • false
                                            • final
                                            • finally
                                            • for
                                            • function
                                            • get
                                            • hide
                                            • if
                                            • implements
                                            • import
                                            • in
                                            • inout
                                            • interface
                                            • is
                                            • late
                                            • library
                                            • mixin
                                            • native
                                            • new
                                            • null
                                            • of
                                            • on
                                            • operator
                                            • out
                                            • part
                                            • patch
                                            • required
                                            • rethrow
                                            • return
                                            • set
                                            • show
                                            • source
                                            • static
                                            • super
                                            • switch
                                            • sync
                                            • this
                                            • throw
                                            • true
                                            • try
                                            • typedef
                                            • var
                                            • void
                                            • while
                                            • with
                                            • yield

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✓ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✓ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✗OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            - + - + - + diff --git a/docs/generators/dart-jaguar/index.html b/docs/generators/dart-jaguar/index.html index fe984c02e4c..44d7c834024 100644 --- a/docs/generators/dart-jaguar/index.html +++ b/docs/generators/dart-jaguar/index.html @@ -21,26 +21,26 @@ - +
                                            -

                                            Config Options for dart-jaguar

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            browserClientIs the client browser based (for Dart 1.x only)null
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            nullableFieldsIs the null fields should be in the JSON payloadnull
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            pubAuthorAuthor name in generated pubspecnull
                                            pubAuthorEmailEmail address of the author in generated pubspecnull
                                            pubDescriptionDescription in generated pubspecnull
                                            pubHomepageHomepage in generated pubspecnull
                                            pubNameName in generated pubspecnull
                                            pubVersionVersion in generated pubspecnull
                                            serializationChoose serialization format JSON or PROTO is supportednull
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                            sourceFolderSource folder for generated codenull
                                            supportDart2Support Dart 2.x (Dart 1.x support has been deprecated)true
                                            useEnumExtensionAllow the 'x-enum-values' extension for enumsnull

                                            IMPORT MAPPING

                                            Type/AliasImports

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayList
                                            mapMap

                                            LANGUAGE PRIMITIVES

                                            • String
                                            • bool
                                            • double
                                            • int
                                            • num

                                            RESERVED WORDS

                                            • abstract
                                            • as
                                            • assert
                                            • async
                                            • await
                                            • break
                                            • case
                                            • catch
                                            • class
                                            • const
                                            • continue
                                            • covariant
                                            • default
                                            • deferred
                                            • do
                                            • dynamic
                                            • else
                                            • enum
                                            • export
                                            • extends
                                            • extension
                                            • external
                                            • factory
                                            • false
                                            • final
                                            • finally
                                            • for
                                            • function
                                            • get
                                            • hide
                                            • if
                                            • implements
                                            • import
                                            • in
                                            • inout
                                            • interface
                                            • is
                                            • late
                                            • library
                                            • mixin
                                            • native
                                            • new
                                            • null
                                            • of
                                            • on
                                            • operator
                                            • out
                                            • part
                                            • patch
                                            • required
                                            • rethrow
                                            • return
                                            • set
                                            • show
                                            • source
                                            • static
                                            • super
                                            • switch
                                            • sync
                                            • this
                                            • throw
                                            • true
                                            • try
                                            • typedef
                                            • var
                                            • void
                                            • while
                                            • with
                                            • yield

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✓ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✓ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✗OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            +

                                            Config Options for dart-jaguar

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            browserClientIs the client browser based (for Dart 1.x only)null
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            nullableFieldsIs the null fields should be in the JSON payloadnull
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            pubAuthorAuthor name in generated pubspecnull
                                            pubAuthorEmailEmail address of the author in generated pubspecnull
                                            pubDescriptionDescription in generated pubspecnull
                                            pubHomepageHomepage in generated pubspecnull
                                            pubNameName in generated pubspecnull
                                            pubVersionVersion in generated pubspecnull
                                            serializationChoose serialization format JSON or PROTO is supportednull
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                            sourceFolderSource folder for generated codenull
                                            supportDart2Support Dart 2.x (Dart 1.x support has been deprecated)true
                                            useEnumExtensionAllow the 'x-enum-values' extension for enumsnull

                                            IMPORT MAPPING

                                            Type/AliasImports

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayList
                                            mapMap

                                            LANGUAGE PRIMITIVES

                                            • String
                                            • bool
                                            • double
                                            • int
                                            • num

                                            RESERVED WORDS

                                            • abstract
                                            • as
                                            • assert
                                            • async
                                            • await
                                            • break
                                            • case
                                            • catch
                                            • class
                                            • const
                                            • continue
                                            • covariant
                                            • default
                                            • deferred
                                            • do
                                            • dynamic
                                            • else
                                            • enum
                                            • export
                                            • extends
                                            • extension
                                            • external
                                            • factory
                                            • false
                                            • final
                                            • finally
                                            • for
                                            • function
                                            • get
                                            • hide
                                            • if
                                            • implements
                                            • import
                                            • in
                                            • inout
                                            • interface
                                            • is
                                            • late
                                            • library
                                            • mixin
                                            • native
                                            • new
                                            • null
                                            • of
                                            • on
                                            • operator
                                            • out
                                            • part
                                            • patch
                                            • required
                                            • rethrow
                                            • return
                                            • set
                                            • show
                                            • source
                                            • static
                                            • super
                                            • switch
                                            • sync
                                            • this
                                            • throw
                                            • true
                                            • try
                                            • typedef
                                            • var
                                            • void
                                            • while
                                            • with
                                            • yield

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✓ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✓ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✗OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            - + - + - + diff --git a/docs/generators/dart/index.html b/docs/generators/dart/index.html index 7f2b504cf3a..b0f30f34769 100644 --- a/docs/generators/dart/index.html +++ b/docs/generators/dart/index.html @@ -21,26 +21,26 @@ - +
                                            -

                                            Config Options for dart

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            browserClientIs the client browser based (for Dart 1.x only)null
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            pubAuthorAuthor name in generated pubspecnull
                                            pubAuthorEmailEmail address of the author in generated pubspecnull
                                            pubDescriptionDescription in generated pubspecnull
                                            pubHomepageHomepage in generated pubspecnull
                                            pubNameName in generated pubspecnull
                                            pubVersionVersion in generated pubspecnull
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                            sourceFolderSource folder for generated codenull
                                            supportDart2Support Dart 2.x (Dart 1.x support has been deprecated)true
                                            useEnumExtensionAllow the 'x-enum-values' extension for enumsnull

                                            IMPORT MAPPING

                                            Type/AliasImports

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayList
                                            mapMap

                                            LANGUAGE PRIMITIVES

                                            • String
                                            • bool
                                            • double
                                            • int
                                            • num

                                            RESERVED WORDS

                                            • abstract
                                            • as
                                            • assert
                                            • async
                                            • await
                                            • break
                                            • case
                                            • catch
                                            • class
                                            • const
                                            • continue
                                            • covariant
                                            • default
                                            • deferred
                                            • do
                                            • dynamic
                                            • else
                                            • enum
                                            • export
                                            • extends
                                            • extension
                                            • external
                                            • factory
                                            • false
                                            • final
                                            • finally
                                            • for
                                            • function
                                            • get
                                            • hide
                                            • if
                                            • implements
                                            • import
                                            • in
                                            • inout
                                            • interface
                                            • is
                                            • late
                                            • library
                                            • mixin
                                            • native
                                            • new
                                            • null
                                            • of
                                            • on
                                            • operator
                                            • out
                                            • part
                                            • patch
                                            • required
                                            • rethrow
                                            • return
                                            • set
                                            • show
                                            • source
                                            • static
                                            • super
                                            • switch
                                            • sync
                                            • this
                                            • throw
                                            • true
                                            • try
                                            • typedef
                                            • var
                                            • void
                                            • while
                                            • with
                                            • yield

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✓ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✓ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✗OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            +

                                            Config Options for dart

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            browserClientIs the client browser based (for Dart 1.x only)null
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            pubAuthorAuthor name in generated pubspecnull
                                            pubAuthorEmailEmail address of the author in generated pubspecnull
                                            pubDescriptionDescription in generated pubspecnull
                                            pubHomepageHomepage in generated pubspecnull
                                            pubNameName in generated pubspecnull
                                            pubVersionVersion in generated pubspecnull
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                            sourceFolderSource folder for generated codenull
                                            supportDart2Support Dart 2.x (Dart 1.x support has been deprecated)true
                                            useEnumExtensionAllow the 'x-enum-values' extension for enumsnull

                                            IMPORT MAPPING

                                            Type/AliasImports

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayList
                                            mapMap

                                            LANGUAGE PRIMITIVES

                                            • String
                                            • bool
                                            • double
                                            • int
                                            • num

                                            RESERVED WORDS

                                            • abstract
                                            • as
                                            • assert
                                            • async
                                            • await
                                            • break
                                            • case
                                            • catch
                                            • class
                                            • const
                                            • continue
                                            • covariant
                                            • default
                                            • deferred
                                            • do
                                            • dynamic
                                            • else
                                            • enum
                                            • export
                                            • extends
                                            • extension
                                            • external
                                            • factory
                                            • false
                                            • final
                                            • finally
                                            • for
                                            • function
                                            • get
                                            • hide
                                            • if
                                            • implements
                                            • import
                                            • in
                                            • inout
                                            • interface
                                            • is
                                            • late
                                            • library
                                            • mixin
                                            • native
                                            • new
                                            • null
                                            • of
                                            • on
                                            • operator
                                            • out
                                            • part
                                            • patch
                                            • required
                                            • rethrow
                                            • return
                                            • set
                                            • show
                                            • source
                                            • static
                                            • super
                                            • switch
                                            • sync
                                            • this
                                            • throw
                                            • true
                                            • try
                                            • typedef
                                            • var
                                            • void
                                            • while
                                            • with
                                            • yield

                                            FEATURE SET

                                            Client Modification Feature

                                            NameSupportedDefined By
                                            BasePath✓ToolingExtension
                                            Authorizations✗ToolingExtension
                                            UserAgent✗ToolingExtension

                                            Data Type Feature

                                            NameSupportedDefined By
                                            Custom✗OAS2,OAS3
                                            Int32✓OAS2,OAS3
                                            Int64✓OAS2,OAS3
                                            Float✓OAS2,OAS3
                                            Double✓OAS2,OAS3
                                            Decimal✓ToolingExtension
                                            String✓OAS2,OAS3
                                            Byte✓OAS2,OAS3
                                            Binary✓OAS2,OAS3
                                            Boolean✓OAS2,OAS3
                                            Date✓OAS2,OAS3
                                            DateTime✓OAS2,OAS3
                                            Password✓OAS2,OAS3
                                            File✓OAS2
                                            Array✓OAS2,OAS3
                                            Maps✓ToolingExtension
                                            CollectionFormat✓OAS2
                                            CollectionFormatMulti✓OAS2
                                            Enum✓OAS2,OAS3
                                            ArrayOfEnum✓ToolingExtension
                                            ArrayOfModel✓ToolingExtension
                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                            ArrayOfCollectionOfModel✓ToolingExtension
                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                            MapOfEnum✓ToolingExtension
                                            MapOfModel✓ToolingExtension
                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                            MapOfCollectionOfModel✓ToolingExtension
                                            MapOfCollectionOfEnum✓ToolingExtension

                                            Documentation Feature

                                            NameSupportedDefined By
                                            Readme✓ToolingExtension
                                            Model✓ToolingExtension
                                            Api✓ToolingExtension

                                            Global Feature

                                            NameSupportedDefined By
                                            Host✓OAS2,OAS3
                                            BasePath✓OAS2,OAS3
                                            Info✓OAS2,OAS3
                                            Schemes✗OAS2,OAS3
                                            PartialSchemes✓OAS2,OAS3
                                            Consumes✓OAS2
                                            Produces✓OAS2
                                            ExternalDocumentation✓OAS2,OAS3
                                            Examples✓OAS2,OAS3
                                            XMLStructureDefinitions✗OAS2,OAS3
                                            MultiServer✗OAS3
                                            ParameterizedServer✗OAS3
                                            ParameterStyling✗OAS3
                                            Callbacks✗OAS3
                                            LinkObjects✗OAS3

                                            Parameter Feature

                                            NameSupportedDefined By
                                            Path✓OAS2,OAS3
                                            Query✓OAS2,OAS3
                                            Header✓OAS2,OAS3
                                            Body✓OAS2
                                            FormUnencoded✓OAS2
                                            FormMultipart✓OAS2
                                            Cookie✓OAS3

                                            Schema Support Feature

                                            NameSupportedDefined By
                                            Simple✓OAS2,OAS3
                                            Composite✓OAS2,OAS3
                                            Polymorphism✗OAS2,OAS3
                                            Union✗OAS3

                                            Security Feature

                                            NameSupportedDefined By
                                            BasicAuth✓OAS2,OAS3
                                            ApiKey✓OAS2,OAS3
                                            OpenIDConnect✗OAS3
                                            BearerToken✗OAS3
                                            OAuth2_Implicit✓OAS2,OAS3
                                            OAuth2_Password✗OAS2,OAS3
                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                            Wire Format Feature

                                            NameSupportedDefined By
                                            JSON✓OAS2,OAS3
                                            XML✓OAS2,OAS3
                                            PROTOBUF✗ToolingExtension
                                            Custom✗OAS2,OAS3
                                            Edit this page
                                            Last updated on by Jim Schubert
                                            - + - + - + diff --git a/docs/generators/dynamic-html/index.html b/docs/generators/dynamic-html/index.html index 82204803299..60b0dd559e4 100644 --- a/docs/generators/dynamic-html/index.html +++ b/docs/generators/dynamic-html/index.html @@ -21,26 +21,26 @@ - +
                                            -

                                            Config Options for dynamic-html

                                            OptionDescriptionValuesDefault
                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                            artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                            artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                            groupIdgroupId in generated pom.xmlnull
                                            invokerPackageroot package for generated codenull
                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                            IMPORT MAPPING

                                            Type/AliasImports

                                            INSTANTIATION TYPES

                                            Type/AliasInstantiated By
                                            arrayArrayList
                                            mapHashMap

                                            LANGUAGE PRIMITIVES

                                              RESERVED WORDS

                                                FEATURE SET

                                                Client Modification Feature

                                                NameSupportedDefined By
                                                BasePath✗ToolingExtension
                                                Authorizations✗ToolingExtension
                                                UserAgent✗ToolingExtension

                                                Data Type Feature

                                                NameSupportedDefined By
                                                Custom✓OAS2,OAS3
                                                Int32✓OAS2,OAS3
                                                Int64✓OAS2,OAS3
                                                Float✓OAS2,OAS3
                                                Double✓OAS2,OAS3
                                                Decimal✓ToolingExtension
                                                String✓OAS2,OAS3
                                                Byte✓OAS2,OAS3
                                                Binary✓OAS2,OAS3
                                                Boolean✓OAS2,OAS3
                                                Date✓OAS2,OAS3
                                                DateTime✓OAS2,OAS3
                                                Password✓OAS2,OAS3
                                                File✓OAS2
                                                Array✓OAS2,OAS3
                                                Maps✓ToolingExtension
                                                CollectionFormat✓OAS2
                                                CollectionFormatMulti✓OAS2
                                                Enum✓OAS2,OAS3
                                                ArrayOfEnum✓ToolingExtension
                                                ArrayOfModel✓ToolingExtension
                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                MapOfEnum✓ToolingExtension
                                                MapOfModel✓ToolingExtension
                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                MapOfCollectionOfModel✓ToolingExtension
                                                MapOfCollectionOfEnum✓ToolingExtension

                                                Documentation Feature

                                                NameSupportedDefined By
                                                Readme✓ToolingExtension
                                                Model✓ToolingExtension
                                                Api✓ToolingExtension

                                                Global Feature

                                                NameSupportedDefined By
                                                Host✓OAS2,OAS3
                                                BasePath✓OAS2,OAS3
                                                Info✓OAS2,OAS3
                                                Schemes✓OAS2,OAS3
                                                PartialSchemes✓OAS2,OAS3
                                                Consumes✓OAS2
                                                Produces✓OAS2
                                                ExternalDocumentation✓OAS2,OAS3
                                                Examples✓OAS2,OAS3
                                                XMLStructureDefinitions✓OAS2,OAS3
                                                MultiServer✓OAS3
                                                ParameterizedServer✓OAS3
                                                ParameterStyling✓OAS3
                                                Callbacks✓OAS3
                                                LinkObjects✓OAS3

                                                Parameter Feature

                                                NameSupportedDefined By
                                                Path✓OAS2,OAS3
                                                Query✓OAS2,OAS3
                                                Header✓OAS2,OAS3
                                                Body✓OAS2
                                                FormUnencoded✓OAS2
                                                FormMultipart✓OAS2
                                                Cookie✓OAS3

                                                Schema Support Feature

                                                NameSupportedDefined By
                                                Simple✓OAS2,OAS3
                                                Composite✓OAS2,OAS3
                                                Polymorphism✓OAS2,OAS3
                                                Union✓OAS3

                                                Security Feature

                                                NameSupportedDefined By
                                                BasicAuth✓OAS2,OAS3
                                                ApiKey✓OAS2,OAS3
                                                OpenIDConnect✓OAS3
                                                BearerToken✓OAS3
                                                OAuth2_Implicit✓OAS2,OAS3
                                                OAuth2_Password✓OAS2,OAS3
                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                Wire Format Feature

                                                NameSupportedDefined By
                                                JSON✓OAS2,OAS3
                                                XML✓OAS2,OAS3
                                                PROTOBUF✓ToolingExtension
                                                Custom✓OAS2,OAS3
                                                Edit this page
                                                Last updated on by Jim Schubert
                                                +

                                                Config Options for dynamic-html

                                                OptionDescriptionValuesDefault
                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                groupIdgroupId in generated pom.xmlnull
                                                invokerPackageroot package for generated codenull
                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                IMPORT MAPPING

                                                Type/AliasImports

                                                INSTANTIATION TYPES

                                                Type/AliasInstantiated By
                                                arrayArrayList
                                                mapHashMap

                                                LANGUAGE PRIMITIVES

                                                  RESERVED WORDS

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✗ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✓OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✓OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✓OAS2,OAS3
                                                    MultiServer✓OAS3
                                                    ParameterizedServer✓OAS3
                                                    ParameterStyling✓OAS3
                                                    Callbacks✓OAS3
                                                    LinkObjects✓OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✓OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✓OAS2,OAS3
                                                    Union✓OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✓OAS2,OAS3
                                                    OpenIDConnect✓OAS3
                                                    BearerToken✓OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✓OAS2,OAS3
                                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                                    OAuth2_AuthorizationCode✓OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✓ToolingExtension
                                                    Custom✓OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    - + - + - + diff --git a/docs/generators/eiffel/index.html b/docs/generators/eiffel/index.html index d9851dbf6e4..6ecfcaf2b55 100644 --- a/docs/generators/eiffel/index.html +++ b/docs/generators/eiffel/index.html @@ -21,26 +21,26 @@ - +
                                                    -

                                                    Config Options for eiffel

                                                    OptionDescriptionValuesDefault
                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                    packageNameEiffel Cluster name (convention: lowercase).openapi
                                                    packageVersionEiffel package version.1.0.0

                                                    IMPORT MAPPING

                                                    Type/AliasImports
                                                    Arrayjava.util.List
                                                    ArrayListjava.util.ArrayList
                                                    BigDecimaljava.math.BigDecimal
                                                    Datejava.util.Date
                                                    DateTimeorg.joda.time.*
                                                    Filejava.io.File
                                                    HashMapjava.util.HashMap
                                                    Listjava.util.*
                                                    LocalDateorg.joda.time.*
                                                    LocalDateTimeorg.joda.time.*
                                                    LocalTimeorg.joda.time.*
                                                    Mapjava.util.Map
                                                    Setjava.util.*
                                                    Timestampjava.sql.Timestamp
                                                    URIjava.net.URI
                                                    UUIDjava.util.UUID

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By
                                                    arrayARRAYED_LIST
                                                    listARRAYED_LIST
                                                    mapSTRING_TABLE

                                                    LANGUAGE PRIMITIVES

                                                    • BOOLEAN
                                                    • INTEGER_16
                                                    • INTEGER_32
                                                    • INTEGER_64
                                                    • INTEGER_8
                                                    • NATURAL_16
                                                    • NATURAL_32
                                                    • NATURAL_64
                                                    • NATURAL_8
                                                    • REAL_32
                                                    • REAL_64

                                                    RESERVED WORDS

                                                    • across
                                                    • agent
                                                    • alias
                                                    • all
                                                    • and
                                                    • as
                                                    • assign
                                                    • attribute
                                                    • check
                                                    • class
                                                    • convert
                                                    • create
                                                    • current
                                                    • debug
                                                    • deferred
                                                    • do
                                                    • else
                                                    • elseif
                                                    • end
                                                    • ensure
                                                    • expanded
                                                    • export
                                                    • external
                                                    • false
                                                    • feature
                                                    • from
                                                    • frozen
                                                    • if
                                                    • implies
                                                    • inherit
                                                    • inspect
                                                    • invariant
                                                    • like
                                                    • local
                                                    • loop
                                                    • not
                                                    • note
                                                    • obsolete
                                                    • old
                                                    • once
                                                    • only
                                                    • or
                                                    • precursor
                                                    • redefine
                                                    • rename
                                                    • require
                                                    • rescue
                                                    • result
                                                    • retry
                                                    • select
                                                    • separate
                                                    • then
                                                    • true
                                                    • tuple
                                                    • undefine
                                                    • until
                                                    • variant
                                                    • void
                                                    • when
                                                    • xor

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✓ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✓OAS2,OAS3
                                                    Union✗OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✓OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    +

                                                    Config Options for eiffel

                                                    OptionDescriptionValuesDefault
                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                    packageNameEiffel Cluster name (convention: lowercase).openapi
                                                    packageVersionEiffel package version.1.0.0

                                                    IMPORT MAPPING

                                                    Type/AliasImports
                                                    Arrayjava.util.List
                                                    ArrayListjava.util.ArrayList
                                                    BigDecimaljava.math.BigDecimal
                                                    Datejava.util.Date
                                                    DateTimeorg.joda.time.*
                                                    Filejava.io.File
                                                    HashMapjava.util.HashMap
                                                    Listjava.util.*
                                                    LocalDateorg.joda.time.*
                                                    LocalDateTimeorg.joda.time.*
                                                    LocalTimeorg.joda.time.*
                                                    Mapjava.util.Map
                                                    Setjava.util.*
                                                    Timestampjava.sql.Timestamp
                                                    URIjava.net.URI
                                                    UUIDjava.util.UUID

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By
                                                    arrayARRAYED_LIST
                                                    listARRAYED_LIST
                                                    mapSTRING_TABLE

                                                    LANGUAGE PRIMITIVES

                                                    • BOOLEAN
                                                    • INTEGER_16
                                                    • INTEGER_32
                                                    • INTEGER_64
                                                    • INTEGER_8
                                                    • NATURAL_16
                                                    • NATURAL_32
                                                    • NATURAL_64
                                                    • NATURAL_8
                                                    • REAL_32
                                                    • REAL_64

                                                    RESERVED WORDS

                                                    • across
                                                    • agent
                                                    • alias
                                                    • all
                                                    • and
                                                    • as
                                                    • assign
                                                    • attribute
                                                    • check
                                                    • class
                                                    • convert
                                                    • create
                                                    • current
                                                    • debug
                                                    • deferred
                                                    • do
                                                    • else
                                                    • elseif
                                                    • end
                                                    • ensure
                                                    • expanded
                                                    • export
                                                    • external
                                                    • false
                                                    • feature
                                                    • from
                                                    • frozen
                                                    • if
                                                    • implies
                                                    • inherit
                                                    • inspect
                                                    • invariant
                                                    • like
                                                    • local
                                                    • loop
                                                    • not
                                                    • note
                                                    • obsolete
                                                    • old
                                                    • once
                                                    • only
                                                    • or
                                                    • precursor
                                                    • redefine
                                                    • rename
                                                    • require
                                                    • rescue
                                                    • result
                                                    • retry
                                                    • select
                                                    • separate
                                                    • then
                                                    • true
                                                    • tuple
                                                    • undefine
                                                    • until
                                                    • variant
                                                    • void
                                                    • when
                                                    • xor

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✓ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✓OAS2,OAS3
                                                    Union✗OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✓OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    - + - + - + diff --git a/docs/generators/elixir/index.html b/docs/generators/elixir/index.html index a8c9a4c66d9..0c9510dd6c0 100644 --- a/docs/generators/elixir/index.html +++ b/docs/generators/elixir/index.html @@ -21,26 +21,26 @@ - +
                                                    -

                                                    Config Options for elixir

                                                    OptionDescriptionValuesDefault
                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay.Petsnull
                                                    licenseHeaderThe license header to prepend to the top of all source files.null
                                                    packageNameElixir package name (convention: lowercase).null
                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                    IMPORT MAPPING

                                                    Type/AliasImports
                                                    Arrayjava.util.List
                                                    ArrayListjava.util.ArrayList
                                                    BigDecimaljava.math.BigDecimal
                                                    Datejava.util.Date
                                                    DateTimeorg.joda.time.*
                                                    Filejava.io.File
                                                    HashMapjava.util.HashMap
                                                    Listjava.util.*
                                                    LocalDateorg.joda.time.*
                                                    LocalDateTimeorg.joda.time.*
                                                    LocalTimeorg.joda.time.*
                                                    Mapjava.util.Map
                                                    Setjava.util.*
                                                    Timestampjava.sql.Timestamp
                                                    URIjava.net.URI
                                                    UUIDjava.util.UUID

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES

                                                    • Atom
                                                    • Boolean
                                                    • DateTime
                                                    • Float
                                                    • Integer
                                                    • List
                                                    • Map
                                                    • PID
                                                    • String
                                                    • Tuple

                                                    RESERVED WORDS

                                                    • __CALLER__
                                                    • __DIR__
                                                    • __ENV__
                                                    • __FILE__
                                                    • __MODULE__
                                                    • false
                                                    • nil
                                                    • true

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✗OAS2,OAS3
                                                    Union✗OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✗OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    +

                                                    Config Options for elixir

                                                    OptionDescriptionValuesDefault
                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay.Petsnull
                                                    licenseHeaderThe license header to prepend to the top of all source files.null
                                                    packageNameElixir package name (convention: lowercase).null
                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                    IMPORT MAPPING

                                                    Type/AliasImports
                                                    Arrayjava.util.List
                                                    ArrayListjava.util.ArrayList
                                                    BigDecimaljava.math.BigDecimal
                                                    Datejava.util.Date
                                                    DateTimeorg.joda.time.*
                                                    Filejava.io.File
                                                    HashMapjava.util.HashMap
                                                    Listjava.util.*
                                                    LocalDateorg.joda.time.*
                                                    LocalDateTimeorg.joda.time.*
                                                    LocalTimeorg.joda.time.*
                                                    Mapjava.util.Map
                                                    Setjava.util.*
                                                    Timestampjava.sql.Timestamp
                                                    URIjava.net.URI
                                                    UUIDjava.util.UUID

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES

                                                    • Atom
                                                    • Boolean
                                                    • DateTime
                                                    • Float
                                                    • Integer
                                                    • List
                                                    • Map
                                                    • PID
                                                    • String
                                                    • Tuple

                                                    RESERVED WORDS

                                                    • __CALLER__
                                                    • __DIR__
                                                    • __ENV__
                                                    • __FILE__
                                                    • __MODULE__
                                                    • false
                                                    • nil
                                                    • true

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✗OAS2,OAS3
                                                    Union✗OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✓OAS2,OAS3
                                                    ApiKey✗OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✓OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✓OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    - + - + - + diff --git a/docs/generators/elm/index.html b/docs/generators/elm/index.html index 6e13e28ab2b..da6f7568cee 100644 --- a/docs/generators/elm/index.html +++ b/docs/generators/elm/index.html @@ -21,26 +21,26 @@ - +
                                                    -

                                                    Config Options for elm

                                                    OptionDescriptionValuesDefault
                                                    elmEnableCustomBasePathsEnable setting the base path for each requestfalse
                                                    elmEnableHttpRequestTrackersEnable adding a tracker to each http requestfalse
                                                    elmPrefixCustomTypeVariantsPrefix custom type variantsfalse
                                                    elmVersionElm version: 0.18, 0.19
                                                    0.19
                                                    Elm 0.19
                                                    0.18
                                                    Elm 0.18
                                                    		0.19

                                                    IMPORT MAPPING

                                                    Type/AliasImports

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By
                                                    arrayList
                                                    mapDict

                                                    LANGUAGE PRIMITIVES

                                                    • Bool
                                                    • Dict
                                                    • Float
                                                    • Int
                                                    • List
                                                    • String

                                                    RESERVED WORDS

                                                    • as
                                                    • case
                                                    • else
                                                    • exposing
                                                    • if
                                                    • import
                                                    • in
                                                    • let
                                                    • module
                                                    • of
                                                    • port
                                                    • then
                                                    • type
                                                    • where

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✗OAS2,OAS3
                                                    Union✗OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✗OAS2,OAS3
                                                    ApiKey✗OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✗OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✗OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    +

                                                    Config Options for elm

                                                    OptionDescriptionValuesDefault
                                                    elmEnableCustomBasePathsEnable setting the base path for each requestfalse
                                                    elmEnableHttpRequestTrackersEnable adding a tracker to each http requestfalse
                                                    elmPrefixCustomTypeVariantsPrefix custom type variantsfalse
                                                    elmVersionElm version: 0.18, 0.19
                                                    0.19
                                                    Elm 0.19
                                                    0.18
                                                    Elm 0.18
                                                    		0.19

                                                    IMPORT MAPPING

                                                    Type/AliasImports

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By
                                                    arrayList
                                                    mapDict

                                                    LANGUAGE PRIMITIVES

                                                    • Bool
                                                    • Dict
                                                    • Float
                                                    • Int
                                                    • List
                                                    • String

                                                    RESERVED WORDS

                                                    • as
                                                    • case
                                                    • else
                                                    • exposing
                                                    • if
                                                    • import
                                                    • in
                                                    • let
                                                    • module
                                                    • of
                                                    • port
                                                    • then
                                                    • type
                                                    • where

                                                    FEATURE SET

                                                    Client Modification Feature

                                                    NameSupportedDefined By
                                                    BasePath✓ToolingExtension
                                                    Authorizations✗ToolingExtension
                                                    UserAgent✗ToolingExtension

                                                    Data Type Feature

                                                    NameSupportedDefined By
                                                    Custom✗OAS2,OAS3
                                                    Int32✓OAS2,OAS3
                                                    Int64✓OAS2,OAS3
                                                    Float✓OAS2,OAS3
                                                    Double✓OAS2,OAS3
                                                    Decimal✓ToolingExtension
                                                    String✓OAS2,OAS3
                                                    Byte✓OAS2,OAS3
                                                    Binary✓OAS2,OAS3
                                                    Boolean✓OAS2,OAS3
                                                    Date✓OAS2,OAS3
                                                    DateTime✓OAS2,OAS3
                                                    Password✓OAS2,OAS3
                                                    File✓OAS2
                                                    Array✓OAS2,OAS3
                                                    Maps✓ToolingExtension
                                                    CollectionFormat✓OAS2
                                                    CollectionFormatMulti✓OAS2
                                                    Enum✓OAS2,OAS3
                                                    ArrayOfEnum✓ToolingExtension
                                                    ArrayOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                    MapOfEnum✓ToolingExtension
                                                    MapOfModel✓ToolingExtension
                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                    MapOfCollectionOfModel✓ToolingExtension
                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                    Documentation Feature

                                                    NameSupportedDefined By
                                                    Readme✓ToolingExtension
                                                    Model✓ToolingExtension
                                                    Api✓ToolingExtension

                                                    Global Feature

                                                    NameSupportedDefined By
                                                    Host✓OAS2,OAS3
                                                    BasePath✓OAS2,OAS3
                                                    Info✓OAS2,OAS3
                                                    Schemes✗OAS2,OAS3
                                                    PartialSchemes✓OAS2,OAS3
                                                    Consumes✓OAS2
                                                    Produces✓OAS2
                                                    ExternalDocumentation✓OAS2,OAS3
                                                    Examples✓OAS2,OAS3
                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                    MultiServer✗OAS3
                                                    ParameterizedServer✗OAS3
                                                    ParameterStyling✗OAS3
                                                    Callbacks✗OAS3
                                                    LinkObjects✗OAS3

                                                    Parameter Feature

                                                    NameSupportedDefined By
                                                    Path✓OAS2,OAS3
                                                    Query✓OAS2,OAS3
                                                    Header✓OAS2,OAS3
                                                    Body✓OAS2
                                                    FormUnencoded✓OAS2
                                                    FormMultipart✓OAS2
                                                    Cookie✗OAS3

                                                    Schema Support Feature

                                                    NameSupportedDefined By
                                                    Simple✓OAS2,OAS3
                                                    Composite✓OAS2,OAS3
                                                    Polymorphism✗OAS2,OAS3
                                                    Union✗OAS3

                                                    Security Feature

                                                    NameSupportedDefined By
                                                    BasicAuth✗OAS2,OAS3
                                                    ApiKey✗OAS2,OAS3
                                                    OpenIDConnect✗OAS3
                                                    BearerToken✗OAS3
                                                    OAuth2_Implicit✗OAS2,OAS3
                                                    OAuth2_Password✗OAS2,OAS3
                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                    Wire Format Feature

                                                    NameSupportedDefined By
                                                    JSON✓OAS2,OAS3
                                                    XML✗OAS2,OAS3
                                                    PROTOBUF✗ToolingExtension
                                                    Custom✗OAS2,OAS3
                                                    Edit this page
                                                    Last updated on by Jim Schubert
                                                    - + - + - + diff --git a/docs/generators/erlang-client/index.html b/docs/generators/erlang-client/index.html index 43116bdcb67..77f79537031 100644 --- a/docs/generators/erlang-client/index.html +++ b/docs/generators/erlang-client/index.html @@ -21,26 +21,26 @@ - +
                                                    -

                                                    Config Options for erlang-client

                                                    OptionDescriptionValuesDefault
                                                    packageNameErlang application name (convention: lowercase).openapi
                                                    packageVersionErlang application version1.0.0

                                                    IMPORT MAPPING

                                                    Type/AliasImports
                                                    Arrayjava.util.List
                                                    ArrayListjava.util.ArrayList
                                                    BigDecimaljava.math.BigDecimal
                                                    Datejava.util.Date
                                                    DateTimeorg.joda.time.*
                                                    Filejava.io.File
                                                    HashMapjava.util.HashMap
                                                    Listjava.util.*
                                                    LocalDateorg.joda.time.*
                                                    LocalDateTimeorg.joda.time.*
                                                    LocalTimeorg.joda.time.*
                                                    Mapjava.util.Map
                                                    Setjava.util.*
                                                    Timestampjava.sql.Timestamp
                                                    URIjava.net.URI
                                                    UUIDjava.util.UUID

                                                    INSTANTIATION TYPES

                                                    Type/AliasInstantiated By

                                                    LANGUAGE PRIMITIVES

                                                      RESERVED WORDS

                                                      • after
                                                      • and
                                                      • andalso
                                                      • band
                                                      • begin
                                                      • bnot
                                                      • bor
                                                      • bsl
                                                      • bsr
                                                      • bxor
                                                      • case
                                                      • catch
                                                      • cond
                                                      • div
                                                      • end
                                                      • fun
                                                      • if
                                                      • let
                                                      • not
                                                      • of
                                                      • or
                                                      • orelse
                                                      • receive
                                                      • rem
                                                      • try
                                                      • when
                                                      • xor

                                                      FEATURE SET

                                                      Client Modification Feature

                                                      NameSupportedDefined By
                                                      BasePath✓ToolingExtension
                                                      Authorizations✗ToolingExtension
                                                      UserAgent✗ToolingExtension

                                                      Data Type Feature

                                                      NameSupportedDefined By
                                                      Custom✗OAS2,OAS3
                                                      Int32✓OAS2,OAS3
                                                      Int64✓OAS2,OAS3
                                                      Float✓OAS2,OAS3
                                                      Double✓OAS2,OAS3
                                                      Decimal✓ToolingExtension
                                                      String✓OAS2,OAS3
                                                      Byte✓OAS2,OAS3
                                                      Binary✓OAS2,OAS3
                                                      Boolean✓OAS2,OAS3
                                                      Date✓OAS2,OAS3
                                                      DateTime✓OAS2,OAS3
                                                      Password✓OAS2,OAS3
                                                      File✓OAS2
                                                      Array✓OAS2,OAS3
                                                      Maps✓ToolingExtension
                                                      CollectionFormat✓OAS2
                                                      CollectionFormatMulti✓OAS2
                                                      Enum✓OAS2,OAS3
                                                      ArrayOfEnum✓ToolingExtension
                                                      ArrayOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                      ArrayOfCollectionOfModel✓ToolingExtension
                                                      ArrayOfCollectionOfEnum✓ToolingExtension
                                                      MapOfEnum✓ToolingExtension
                                                      MapOfModel✓ToolingExtension
                                                      MapOfCollectionOfPrimitives✓ToolingExtension
                                                      MapOfCollectionOfModel✓ToolingExtension
                                                      MapOfCollectionOfEnum✓ToolingExtension

                                                      Documentation Feature

                                                      NameSupportedDefined By
                                                      Readme✓ToolingExtension
                                                      Model✓ToolingExtension
                                                      Api✓ToolingExtension

                                                      Global Feature

                                                      NameSupportedDefined By
                                                      Host✓OAS2,OAS3
                                                      BasePath✓OAS2,OAS3
                                                      Info✓OAS2,OAS3
                                                      Schemes✗OAS2,OAS3
                                                      PartialSchemes✓OAS2,OAS3
                                                      Consumes✓OAS2
                                                      Produces✓OAS2
                                                      ExternalDocumentation✓OAS2,OAS3
                                                      Examples✓OAS2,OAS3
                                                      XMLStructureDefinitions✗OAS2,OAS3
                                                      MultiServer✗OAS3
                                                      ParameterizedServer✗OAS3
                                                      ParameterStyling✗OAS3
                                                      Callbacks✗OAS3
                                                      LinkObjects✗OAS3

                                                      Parameter Feature

                                                      NameSupportedDefined By
                                                      Path✓OAS2,OAS3
                                                      Query✓OAS2,OAS3
                                                      Header✓OAS2,OAS3
                                                      Body✓OAS2
                                                      FormUnencoded✓OAS2
                                                      FormMultipart✓OAS2
                                                      Cookie✗OAS3

                                                      Schema Support Feature

                                                      NameSupportedDefined By
                                                      Simple✓OAS2,OAS3
                                                      Composite✓OAS2,OAS3
                                                      Polymorphism✗OAS2,OAS3
                                                      Union✗OAS3

                                                      Security Feature

                                                      NameSupportedDefined By
                                                      BasicAuth✗OAS2,OAS3
                                                      ApiKey✓OAS2,OAS3
                                                      OpenIDConnect✗OAS3
                                                      BearerToken✗OAS3
                                                      OAuth2_Implicit✗OAS2,OAS3
                                                      OAuth2_Password✗OAS2,OAS3
                                                      OAuth2_ClientCredentials✗OAS2,OAS3
                                                      OAuth2_AuthorizationCode✗OAS2,OAS3

                                                      Wire Format Feature

                                                      NameSupportedDefined By
                                                      JSON✓OAS2,OAS3
                                                      XML✗OAS2,OAS3
                                                      PROTOBUF✗ToolingExtension
                                                      Custom✗OAS2,OAS3
                                                      Edit this page
                                                      Last updated on by Jim Schubert
                                                      +

                                                      Config Options for erlang-client

                                                      OptionDescriptionValuesDefault
                                                      packageNameErlang application name (convention: lowercase).openapi
                                                      packageVersionErlang application version1.0.0

                                                      IMPORT MAPPING

                                                      Type/AliasImports
                                                      Arrayjava.util.List
                                                      ArrayListjava.util.ArrayList
                                                      BigDecimaljava.math.BigDecimal
                                                      Datejava.util.Date
                                                      DateTimeorg.joda.time.*
                                                      Filejava.io.File
                                                      HashMapjava.util.HashMap
                                                      Listjava.util.*
                                                      LocalDateorg.joda.time.*
                                                      LocalDateTimeorg.joda.time.*
                                                      LocalTimeorg.joda.time.*
                                                      Mapjava.util.Map
                                                      Setjava.util.*
                                                      Timestampjava.sql.Timestamp
                                                      URIjava.net.URI
                                                      UUIDjava.util.UUID

                                                      INSTANTIATION TYPES

                                                      Type/AliasInstantiated By

                                                      LANGUAGE PRIMITIVES

                                                        RESERVED WORDS

                                                        • after
                                                        • and
                                                        • andalso
                                                        • band
                                                        • begin
                                                        • bnot
                                                        • bor
                                                        • bsl
                                                        • bsr
                                                        • bxor
                                                        • case
                                                        • catch
                                                        • cond
                                                        • div
                                                        • end
                                                        • fun
                                                        • if
                                                        • let
                                                        • not
                                                        • of
                                                        • or
                                                        • orelse
                                                        • receive
                                                        • rem
                                                        • try
                                                        • when
                                                        • xor

                                                        FEATURE SET

                                                        Client Modification Feature

                                                        NameSupportedDefined By
                                                        BasePath✓ToolingExtension
                                                        Authorizations✗ToolingExtension
                                                        UserAgent✗ToolingExtension

                                                        Data Type Feature

                                                        NameSupportedDefined By
                                                        Custom✗OAS2,OAS3
                                                        Int32✓OAS2,OAS3
                                                        Int64✓OAS2,OAS3
                                                        Float✓OAS2,OAS3
                                                        Double✓OAS2,OAS3
                                                        Decimal✓ToolingExtension
                                                        String✓OAS2,OAS3
                                                        Byte✓OAS2,OAS3
                                                        Binary✓OAS2,OAS3
                                                        Boolean✓OAS2,OAS3
                                                        Date✓OAS2,OAS3
                                                        DateTime✓OAS2,OAS3
                                                        Password✓OAS2,OAS3
                                                        File✓OAS2
                                                        Array✓OAS2,OAS3
                                                        Maps✓ToolingExtension
                                                        CollectionFormat✓OAS2
                                                        CollectionFormatMulti✓OAS2
                                                        Enum✓OAS2,OAS3
                                                        ArrayOfEnum✓ToolingExtension
                                                        ArrayOfModel✓ToolingExtension
                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                        MapOfEnum✓ToolingExtension
                                                        MapOfModel✓ToolingExtension
                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                        MapOfCollectionOfModel✓ToolingExtension
                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                        Documentation Feature

                                                        NameSupportedDefined By
                                                        Readme✓ToolingExtension
                                                        Model✓ToolingExtension
                                                        Api✓ToolingExtension

                                                        Global Feature

                                                        NameSupportedDefined By
                                                        Host✓OAS2,OAS3
                                                        BasePath✓OAS2,OAS3
                                                        Info✓OAS2,OAS3
                                                        Schemes✗OAS2,OAS3
                                                        PartialSchemes✓OAS2,OAS3
                                                        Consumes✓OAS2
                                                        Produces✓OAS2
                                                        ExternalDocumentation✓OAS2,OAS3
                                                        Examples✓OAS2,OAS3
                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                        MultiServer✗OAS3
                                                        ParameterizedServer✗OAS3
                                                        ParameterStyling✗OAS3
                                                        Callbacks✗OAS3
                                                        LinkObjects✗OAS3

                                                        Parameter Feature

                                                        NameSupportedDefined By
                                                        Path✓OAS2,OAS3
                                                        Query✓OAS2,OAS3
                                                        Header✓OAS2,OAS3
                                                        Body✓OAS2
                                                        FormUnencoded✓OAS2
                                                        FormMultipart✓OAS2
                                                        Cookie✗OAS3

                                                        Schema Support Feature

                                                        NameSupportedDefined By
                                                        Simple✓OAS2,OAS3
                                                        Composite✓OAS2,OAS3
                                                        Polymorphism✗OAS2,OAS3
                                                        Union✗OAS3

                                                        Security Feature

                                                        NameSupportedDefined By
                                                        BasicAuth✗OAS2,OAS3
                                                        ApiKey✓OAS2,OAS3
                                                        OpenIDConnect✗OAS3
                                                        BearerToken✗OAS3
                                                        OAuth2_Implicit✗OAS2,OAS3
                                                        OAuth2_Password✗OAS2,OAS3
                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                        Wire Format Feature

                                                        NameSupportedDefined By
                                                        JSON✓OAS2,OAS3
                                                        XML✗OAS2,OAS3
                                                        PROTOBUF✗ToolingExtension
                                                        Custom✗OAS2,OAS3
                                                        Edit this page
                                                        Last updated on by Jim Schubert
                                                        - + - + - + diff --git a/docs/generators/erlang-proper/index.html b/docs/generators/erlang-proper/index.html index 0682445998e..7732a1d7875 100644 --- a/docs/generators/erlang-proper/index.html +++ b/docs/generators/erlang-proper/index.html @@ -21,26 +21,26 @@ - +
                                                        -

                                                        Config Options for erlang-proper

                                                        OptionDescriptionValuesDefault
                                                        packageNameErlang application name (convention: lowercase).openapi
                                                        packageVersionErlang application version1.0.0

                                                        IMPORT MAPPING

                                                        Type/AliasImports
                                                        Arrayjava.util.List
                                                        ArrayListjava.util.ArrayList
                                                        BigDecimaljava.math.BigDecimal
                                                        Datejava.util.Date
                                                        DateTimeorg.joda.time.*
                                                        Filejava.io.File
                                                        HashMapjava.util.HashMap
                                                        Listjava.util.*
                                                        LocalDateorg.joda.time.*
                                                        LocalDateTimeorg.joda.time.*
                                                        LocalTimeorg.joda.time.*
                                                        Mapjava.util.Map
                                                        Setjava.util.*
                                                        Timestampjava.sql.Timestamp
                                                        URIjava.net.URI
                                                        UUIDjava.util.UUID

                                                        INSTANTIATION TYPES

                                                        Type/AliasInstantiated By

                                                        LANGUAGE PRIMITIVES

                                                          RESERVED WORDS

                                                          • after
                                                          • and
                                                          • andalso
                                                          • band
                                                          • begin
                                                          • bnot
                                                          • bor
                                                          • bsl
                                                          • bsr
                                                          • bxor
                                                          • case
                                                          • catch
                                                          • cond
                                                          • div
                                                          • end
                                                          • fun
                                                          • if
                                                          • let
                                                          • not
                                                          • of
                                                          • or
                                                          • orelse
                                                          • receive
                                                          • rem
                                                          • try
                                                          • when
                                                          • xor

                                                          FEATURE SET

                                                          Client Modification Feature

                                                          NameSupportedDefined By
                                                          BasePath✓ToolingExtension
                                                          Authorizations✗ToolingExtension
                                                          UserAgent✗ToolingExtension

                                                          Data Type Feature

                                                          NameSupportedDefined By
                                                          Custom✗OAS2,OAS3
                                                          Int32✓OAS2,OAS3
                                                          Int64✓OAS2,OAS3
                                                          Float✓OAS2,OAS3
                                                          Double✓OAS2,OAS3
                                                          Decimal✓ToolingExtension
                                                          String✓OAS2,OAS3
                                                          Byte✓OAS2,OAS3
                                                          Binary✓OAS2,OAS3
                                                          Boolean✓OAS2,OAS3
                                                          Date✓OAS2,OAS3
                                                          DateTime✓OAS2,OAS3
                                                          Password✓OAS2,OAS3
                                                          File✓OAS2
                                                          Array✓OAS2,OAS3
                                                          Maps✓ToolingExtension
                                                          CollectionFormat✓OAS2
                                                          CollectionFormatMulti✓OAS2
                                                          Enum✓OAS2,OAS3
                                                          ArrayOfEnum✓ToolingExtension
                                                          ArrayOfModel✓ToolingExtension
                                                          ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                          ArrayOfCollectionOfModel✓ToolingExtension
                                                          ArrayOfCollectionOfEnum✓ToolingExtension
                                                          MapOfEnum✓ToolingExtension
                                                          MapOfModel✓ToolingExtension
                                                          MapOfCollectionOfPrimitives✓ToolingExtension
                                                          MapOfCollectionOfModel✓ToolingExtension
                                                          MapOfCollectionOfEnum✓ToolingExtension

                                                          Documentation Feature

                                                          NameSupportedDefined By
                                                          Readme✓ToolingExtension
                                                          Model✓ToolingExtension
                                                          Api✓ToolingExtension

                                                          Global Feature

                                                          NameSupportedDefined By
                                                          Host✓OAS2,OAS3
                                                          BasePath✓OAS2,OAS3
                                                          Info✓OAS2,OAS3
                                                          Schemes✗OAS2,OAS3
                                                          PartialSchemes✓OAS2,OAS3
                                                          Consumes✓OAS2
                                                          Produces✓OAS2
                                                          ExternalDocumentation✓OAS2,OAS3
                                                          Examples✓OAS2,OAS3
                                                          XMLStructureDefinitions✗OAS2,OAS3
                                                          MultiServer✗OAS3
                                                          ParameterizedServer✗OAS3
                                                          ParameterStyling✗OAS3
                                                          Callbacks✗OAS3
                                                          LinkObjects✗OAS3

                                                          Parameter Feature

                                                          NameSupportedDefined By
                                                          Path✓OAS2,OAS3
                                                          Query✓OAS2,OAS3
                                                          Header✓OAS2,OAS3
                                                          Body✓OAS2
                                                          FormUnencoded✓OAS2
                                                          FormMultipart✓OAS2
                                                          Cookie✗OAS3

                                                          Schema Support Feature

                                                          NameSupportedDefined By
                                                          Simple✓OAS2,OAS3
                                                          Composite✓OAS2,OAS3
                                                          Polymorphism✗OAS2,OAS3
                                                          Union✗OAS3

                                                          Security Feature

                                                          NameSupportedDefined By
                                                          BasicAuth✓OAS2,OAS3
                                                          ApiKey✓OAS2,OAS3
                                                          OpenIDConnect✗OAS3
                                                          BearerToken✗OAS3
                                                          OAuth2_Implicit✗OAS2,OAS3
                                                          OAuth2_Password✗OAS2,OAS3
                                                          OAuth2_ClientCredentials✗OAS2,OAS3
                                                          OAuth2_AuthorizationCode✗OAS2,OAS3

                                                          Wire Format Feature

                                                          NameSupportedDefined By
                                                          JSON✓OAS2,OAS3
                                                          XML✗OAS2,OAS3
                                                          PROTOBUF✗ToolingExtension
                                                          Custom✗OAS2,OAS3
                                                          Edit this page
                                                          Last updated on by Jim Schubert
                                                          +

                                                          Config Options for erlang-proper

                                                          OptionDescriptionValuesDefault
                                                          packageNameErlang application name (convention: lowercase).openapi
                                                          packageVersionErlang application version1.0.0

                                                          IMPORT MAPPING

                                                          Type/AliasImports
                                                          Arrayjava.util.List
                                                          ArrayListjava.util.ArrayList
                                                          BigDecimaljava.math.BigDecimal
                                                          Datejava.util.Date
                                                          DateTimeorg.joda.time.*
                                                          Filejava.io.File
                                                          HashMapjava.util.HashMap
                                                          Listjava.util.*
                                                          LocalDateorg.joda.time.*
                                                          LocalDateTimeorg.joda.time.*
                                                          LocalTimeorg.joda.time.*
                                                          Mapjava.util.Map
                                                          Setjava.util.*
                                                          Timestampjava.sql.Timestamp
                                                          URIjava.net.URI
                                                          UUIDjava.util.UUID

                                                          INSTANTIATION TYPES

                                                          Type/AliasInstantiated By

                                                          LANGUAGE PRIMITIVES

                                                            RESERVED WORDS

                                                            • after
                                                            • and
                                                            • andalso
                                                            • band
                                                            • begin
                                                            • bnot
                                                            • bor
                                                            • bsl
                                                            • bsr
                                                            • bxor
                                                            • case
                                                            • catch
                                                            • cond
                                                            • div
                                                            • end
                                                            • fun
                                                            • if
                                                            • let
                                                            • not
                                                            • of
                                                            • or
                                                            • orelse
                                                            • receive
                                                            • rem
                                                            • try
                                                            • when
                                                            • xor

                                                            FEATURE SET

                                                            Client Modification Feature

                                                            NameSupportedDefined By
                                                            BasePath✓ToolingExtension
                                                            Authorizations✗ToolingExtension
                                                            UserAgent✗ToolingExtension

                                                            Data Type Feature

                                                            NameSupportedDefined By
                                                            Custom✗OAS2,OAS3
                                                            Int32✓OAS2,OAS3
                                                            Int64✓OAS2,OAS3
                                                            Float✓OAS2,OAS3
                                                            Double✓OAS2,OAS3
                                                            Decimal✓ToolingExtension
                                                            String✓OAS2,OAS3
                                                            Byte✓OAS2,OAS3
                                                            Binary✓OAS2,OAS3
                                                            Boolean✓OAS2,OAS3
                                                            Date✓OAS2,OAS3
                                                            DateTime✓OAS2,OAS3
                                                            Password✓OAS2,OAS3
                                                            File✓OAS2
                                                            Array✓OAS2,OAS3
                                                            Maps✓ToolingExtension
                                                            CollectionFormat✓OAS2
                                                            CollectionFormatMulti✓OAS2
                                                            Enum✓OAS2,OAS3
                                                            ArrayOfEnum✓ToolingExtension
                                                            ArrayOfModel✓ToolingExtension
                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                            MapOfEnum✓ToolingExtension
                                                            MapOfModel✓ToolingExtension
                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                            MapOfCollectionOfModel✓ToolingExtension
                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                            Documentation Feature

                                                            NameSupportedDefined By
                                                            Readme✓ToolingExtension
                                                            Model✓ToolingExtension
                                                            Api✓ToolingExtension

                                                            Global Feature

                                                            NameSupportedDefined By
                                                            Host✓OAS2,OAS3
                                                            BasePath✓OAS2,OAS3
                                                            Info✓OAS2,OAS3
                                                            Schemes✗OAS2,OAS3
                                                            PartialSchemes✓OAS2,OAS3
                                                            Consumes✓OAS2
                                                            Produces✓OAS2
                                                            ExternalDocumentation✓OAS2,OAS3
                                                            Examples✓OAS2,OAS3
                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                            MultiServer✗OAS3
                                                            ParameterizedServer✗OAS3
                                                            ParameterStyling✗OAS3
                                                            Callbacks✗OAS3
                                                            LinkObjects✗OAS3

                                                            Parameter Feature

                                                            NameSupportedDefined By
                                                            Path✓OAS2,OAS3
                                                            Query✓OAS2,OAS3
                                                            Header✓OAS2,OAS3
                                                            Body✓OAS2
                                                            FormUnencoded✓OAS2
                                                            FormMultipart✓OAS2
                                                            Cookie✗OAS3

                                                            Schema Support Feature

                                                            NameSupportedDefined By
                                                            Simple✓OAS2,OAS3
                                                            Composite✓OAS2,OAS3
                                                            Polymorphism✗OAS2,OAS3
                                                            Union✗OAS3

                                                            Security Feature

                                                            NameSupportedDefined By
                                                            BasicAuth✓OAS2,OAS3
                                                            ApiKey✓OAS2,OAS3
                                                            OpenIDConnect✗OAS3
                                                            BearerToken✗OAS3
                                                            OAuth2_Implicit✗OAS2,OAS3
                                                            OAuth2_Password✗OAS2,OAS3
                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                                            Wire Format Feature

                                                            NameSupportedDefined By
                                                            JSON✓OAS2,OAS3
                                                            XML✗OAS2,OAS3
                                                            PROTOBUF✗ToolingExtension
                                                            Custom✗OAS2,OAS3
                                                            Edit this page
                                                            Last updated on by Jim Schubert
                                                            - + - + - + diff --git a/docs/generators/erlang-server/index.html b/docs/generators/erlang-server/index.html index 255b4639a41..1199a2ef357 100644 --- a/docs/generators/erlang-server/index.html +++ b/docs/generators/erlang-server/index.html @@ -21,26 +21,26 @@ - +
                                                            -

                                                            Config Options for erlang-server

                                                            OptionDescriptionValuesDefault
                                                            openAPISpecNameOpenapi Spec Name.openapi
                                                            packageNameErlang package name (convention: lowercase).openapi

                                                            IMPORT MAPPING

                                                            Type/AliasImports
                                                            Arrayjava.util.List
                                                            ArrayListjava.util.ArrayList
                                                            BigDecimaljava.math.BigDecimal
                                                            Datejava.util.Date
                                                            DateTimeorg.joda.time.*
                                                            Filejava.io.File
                                                            HashMapjava.util.HashMap
                                                            Listjava.util.*
                                                            LocalDateorg.joda.time.*
                                                            LocalDateTimeorg.joda.time.*
                                                            LocalTimeorg.joda.time.*
                                                            Mapjava.util.Map
                                                            Setjava.util.*
                                                            Timestampjava.sql.Timestamp
                                                            URIjava.net.URI
                                                            UUIDjava.util.UUID

                                                            INSTANTIATION TYPES

                                                            Type/AliasInstantiated By

                                                            LANGUAGE PRIMITIVES

                                                              RESERVED WORDS

                                                              • after
                                                              • and
                                                              • andalso
                                                              • band
                                                              • begin
                                                              • bnot
                                                              • bor
                                                              • bsl
                                                              • bsr
                                                              • bxor
                                                              • case
                                                              • catch
                                                              • cond
                                                              • div
                                                              • end
                                                              • fun
                                                              • if
                                                              • let
                                                              • not
                                                              • of
                                                              • or
                                                              • orelse
                                                              • receive
                                                              • rem
                                                              • try
                                                              • when
                                                              • xor

                                                              FEATURE SET

                                                              Client Modification Feature

                                                              NameSupportedDefined By
                                                              BasePath✗ToolingExtension
                                                              Authorizations✗ToolingExtension
                                                              UserAgent✗ToolingExtension

                                                              Data Type Feature

                                                              NameSupportedDefined By
                                                              Custom✗OAS2,OAS3
                                                              Int32✓OAS2,OAS3
                                                              Int64✓OAS2,OAS3
                                                              Float✓OAS2,OAS3
                                                              Double✓OAS2,OAS3
                                                              Decimal✓ToolingExtension
                                                              String✓OAS2,OAS3
                                                              Byte✓OAS2,OAS3
                                                              Binary✓OAS2,OAS3
                                                              Boolean✓OAS2,OAS3
                                                              Date✓OAS2,OAS3
                                                              DateTime✓OAS2,OAS3
                                                              Password✓OAS2,OAS3
                                                              File✓OAS2
                                                              Array✓OAS2,OAS3
                                                              Maps✓ToolingExtension
                                                              CollectionFormat✓OAS2
                                                              CollectionFormatMulti✓OAS2
                                                              Enum✓OAS2,OAS3
                                                              ArrayOfEnum✓ToolingExtension
                                                              ArrayOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                              MapOfEnum✓ToolingExtension
                                                              MapOfModel✓ToolingExtension
                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                              MapOfCollectionOfModel✓ToolingExtension
                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                              Documentation Feature

                                                              NameSupportedDefined By
                                                              Readme✓ToolingExtension
                                                              Model✓ToolingExtension
                                                              Api✓ToolingExtension

                                                              Global Feature

                                                              NameSupportedDefined By
                                                              Host✓OAS2,OAS3
                                                              BasePath✓OAS2,OAS3
                                                              Info✓OAS2,OAS3
                                                              Schemes✗OAS2,OAS3
                                                              PartialSchemes✓OAS2,OAS3
                                                              Consumes✓OAS2
                                                              Produces✓OAS2
                                                              ExternalDocumentation✓OAS2,OAS3
                                                              Examples✓OAS2,OAS3
                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                              MultiServer✗OAS3
                                                              ParameterizedServer✗OAS3
                                                              ParameterStyling✗OAS3
                                                              Callbacks✗OAS3
                                                              LinkObjects✗OAS3

                                                              Parameter Feature

                                                              NameSupportedDefined By
                                                              Path✓OAS2,OAS3
                                                              Query✓OAS2,OAS3
                                                              Header✓OAS2,OAS3
                                                              Body✓OAS2
                                                              FormUnencoded✓OAS2
                                                              FormMultipart✓OAS2
                                                              Cookie✗OAS3

                                                              Schema Support Feature

                                                              NameSupportedDefined By
                                                              Simple✓OAS2,OAS3
                                                              Composite✓OAS2,OAS3
                                                              Polymorphism✗OAS2,OAS3
                                                              Union✗OAS3

                                                              Security Feature

                                                              NameSupportedDefined By
                                                              BasicAuth✗OAS2,OAS3
                                                              ApiKey✓OAS2,OAS3
                                                              OpenIDConnect✗OAS3
                                                              BearerToken✗OAS3
                                                              OAuth2_Implicit✓OAS2,OAS3
                                                              OAuth2_Password✗OAS2,OAS3
                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                              OAuth2_AuthorizationCode✗OAS2,OAS3

                                                              Wire Format Feature

                                                              NameSupportedDefined By
                                                              JSON✓OAS2,OAS3
                                                              XML✗OAS2,OAS3
                                                              PROTOBUF✗ToolingExtension
                                                              Custom✗OAS2,OAS3
                                                              Edit this page
                                                              Last updated on by Jim Schubert
                                                              +

                                                              Config Options for erlang-server

                                                              OptionDescriptionValuesDefault
                                                              openAPISpecNameOpenapi Spec Name.openapi
                                                              packageNameErlang package name (convention: lowercase).openapi

                                                              IMPORT MAPPING

                                                              Type/AliasImports
                                                              Arrayjava.util.List
                                                              ArrayListjava.util.ArrayList
                                                              BigDecimaljava.math.BigDecimal
                                                              Datejava.util.Date
                                                              DateTimeorg.joda.time.*
                                                              Filejava.io.File
                                                              HashMapjava.util.HashMap
                                                              Listjava.util.*
                                                              LocalDateorg.joda.time.*
                                                              LocalDateTimeorg.joda.time.*
                                                              LocalTimeorg.joda.time.*
                                                              Mapjava.util.Map
                                                              Setjava.util.*
                                                              Timestampjava.sql.Timestamp
                                                              URIjava.net.URI
                                                              UUIDjava.util.UUID

                                                              INSTANTIATION TYPES

                                                              Type/AliasInstantiated By

                                                              LANGUAGE PRIMITIVES

                                                                RESERVED WORDS

                                                                • after
                                                                • and
                                                                • andalso
                                                                • band
                                                                • begin
                                                                • bnot
                                                                • bor
                                                                • bsl
                                                                • bsr
                                                                • bxor
                                                                • case
                                                                • catch
                                                                • cond
                                                                • div
                                                                • end
                                                                • fun
                                                                • if
                                                                • let
                                                                • not
                                                                • of
                                                                • or
                                                                • orelse
                                                                • receive
                                                                • rem
                                                                • try
                                                                • when
                                                                • xor

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/flash/index.html b/docs/generators/flash/index.html index dfdda976917..3c0dc69bc98 100644 --- a/docs/generators/flash/index.html +++ b/docs/generators/flash/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for flash

                                                                OptionDescriptionValuesDefault
                                                                invokerPackageroot package for generated codenull
                                                                packageNameflash package name (convention: package.name)org.openapitools
                                                                packageVersionflash package version1.0.0
                                                                sourceFoldersource folder for generated code. e.g. flashnull

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Fileflash.filesystem.File

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Array
                                                                • Boolean
                                                                • Date
                                                                • Dictionary
                                                                • Number
                                                                • String

                                                                RESERVED WORDS

                                                                • add
                                                                • and
                                                                • break
                                                                • continue
                                                                • delete
                                                                • do
                                                                • else
                                                                • eq
                                                                • for
                                                                • function
                                                                • ge
                                                                • gt
                                                                • if
                                                                • ifframeloaded
                                                                • in
                                                                • le
                                                                • lt
                                                                • ne
                                                                • new
                                                                • not
                                                                • on
                                                                • onclipevent
                                                                • or
                                                                • return
                                                                • telltarget
                                                                • this
                                                                • typeof
                                                                • var
                                                                • void
                                                                • while
                                                                • with

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for flash

                                                                OptionDescriptionValuesDefault
                                                                invokerPackageroot package for generated codenull
                                                                packageNameflash package name (convention: package.name)org.openapitools
                                                                packageVersionflash package version1.0.0
                                                                sourceFoldersource folder for generated code. e.g. flashnull

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Fileflash.filesystem.File

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Array
                                                                • Boolean
                                                                • Date
                                                                • Dictionary
                                                                • Number
                                                                • String

                                                                RESERVED WORDS

                                                                • add
                                                                • and
                                                                • break
                                                                • continue
                                                                • delete
                                                                • do
                                                                • else
                                                                • eq
                                                                • for
                                                                • function
                                                                • ge
                                                                • gt
                                                                • if
                                                                • ifframeloaded
                                                                • in
                                                                • le
                                                                • lt
                                                                • ne
                                                                • new
                                                                • not
                                                                • on
                                                                • onclipevent
                                                                • or
                                                                • return
                                                                • telltarget
                                                                • this
                                                                • typeof
                                                                • var
                                                                • void
                                                                • while
                                                                • with

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/fsharp-functions/index.html b/docs/generators/fsharp-functions/index.html index 3c15455b309..52bc9f5ead1 100644 --- a/docs/generators/fsharp-functions/index.html +++ b/docs/generators/fsharp-functions/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for fsharp-functions

                                                                OptionDescriptionValuesDefault
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                licenseNameThe name of the licenseNoLicense
                                                                licenseUrlThe URL of the licensehttp://localhost
                                                                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                                                                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                                                                packageGuidThe GUID that will be associated with the C# projectnull
                                                                packageNameF# module name (convention: Title.Case).OpenAPI
                                                                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                                                                packageVersionF# package version.1.0.0
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                sourceFoldersource folder for generated codeOpenAPI/src

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                IDictionarySystem.Collections.Generic

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By
                                                                arraylist
                                                                listlist
                                                                mapIDictionary

                                                                LANGUAGE PRIMITIVES

                                                                • Collection
                                                                • DataTimeOffset
                                                                • DateTime
                                                                • Dictionary
                                                                • Double
                                                                • ICollection
                                                                • Int32
                                                                • Int64
                                                                • List
                                                                • String
                                                                • System.IO.Stream
                                                                • bool
                                                                • byte[]
                                                                • char
                                                                • decimal
                                                                • dict
                                                                • double
                                                                • float
                                                                • float32
                                                                • int
                                                                • int16
                                                                • int64
                                                                • list
                                                                • nativeint
                                                                • obj
                                                                • seq
                                                                • single
                                                                • string
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • unativeint

                                                                RESERVED WORDS

                                                                • abstract
                                                                • and
                                                                • as
                                                                • assert
                                                                • async
                                                                • await
                                                                • base
                                                                • begin
                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • catch
                                                                • char
                                                                • checked
                                                                • class
                                                                • const
                                                                • continue
                                                                • decimal
                                                                • default
                                                                • delegate
                                                                • do
                                                                • done
                                                                • double
                                                                • downcast
                                                                • downto
                                                                • dynamic
                                                                • elif
                                                                • else
                                                                • end
                                                                • enum
                                                                • event
                                                                • exception
                                                                • explicit
                                                                • extern
                                                                • false
                                                                • finally
                                                                • fixed
                                                                • float
                                                                • for
                                                                • foreach
                                                                • fun
                                                                • function
                                                                • if
                                                                • in
                                                                • inherit
                                                                • inline
                                                                • int
                                                                • interface
                                                                • internal
                                                                • is
                                                                • lazy
                                                                • let
                                                                • let!
                                                                • localVarFileParams
                                                                • localVarFormParams
                                                                • localVarHeaderParams
                                                                • localVarHttpContentType
                                                                • localVarHttpContentTypes
                                                                • localVarHttpHeaderAccept
                                                                • localVarHttpHeaderAccepts
                                                                • localVarPath
                                                                • localVarPathParams
                                                                • localVarPostBody
                                                                • localVarQueryParams
                                                                • localVarResponse
                                                                • localVarStatusCode
                                                                • lock
                                                                • match
                                                                • match!
                                                                • member
                                                                • module
                                                                • mutable
                                                                • namespace
                                                                • new
                                                                • not
                                                                • null
                                                                • of
                                                                • open
                                                                • option
                                                                • or
                                                                • override
                                                                • params
                                                                • private
                                                                • public
                                                                • raise
                                                                • rec
                                                                • return
                                                                • return!
                                                                • sealed
                                                                • select
                                                                • static
                                                                • string
                                                                • struct
                                                                • then
                                                                • to
                                                                • true
                                                                • try
                                                                • type
                                                                • upcast
                                                                • use
                                                                • use!
                                                                • val
                                                                • void
                                                                • volatile
                                                                • when
                                                                • while
                                                                • with
                                                                • yield
                                                                • yield!

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✗ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✗OAS2,OAS3
                                                                BasePath✗OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for fsharp-functions

                                                                OptionDescriptionValuesDefault
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                licenseNameThe name of the licenseNoLicense
                                                                licenseUrlThe URL of the licensehttp://localhost
                                                                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                                                                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                                                                packageGuidThe GUID that will be associated with the C# projectnull
                                                                packageNameF# module name (convention: Title.Case).OpenAPI
                                                                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                                                                packageVersionF# package version.1.0.0
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                sourceFoldersource folder for generated codeOpenAPI/src

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                IDictionarySystem.Collections.Generic

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By
                                                                arraylist
                                                                listlist
                                                                mapIDictionary

                                                                LANGUAGE PRIMITIVES

                                                                • Collection
                                                                • DataTimeOffset
                                                                • DateTime
                                                                • Dictionary
                                                                • Double
                                                                • ICollection
                                                                • Int32
                                                                • Int64
                                                                • List
                                                                • String
                                                                • System.IO.Stream
                                                                • bool
                                                                • byte[]
                                                                • char
                                                                • decimal
                                                                • dict
                                                                • double
                                                                • float
                                                                • float32
                                                                • int
                                                                • int16
                                                                • int64
                                                                • list
                                                                • nativeint
                                                                • obj
                                                                • seq
                                                                • single
                                                                • string
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • unativeint

                                                                RESERVED WORDS

                                                                • abstract
                                                                • and
                                                                • as
                                                                • assert
                                                                • async
                                                                • await
                                                                • base
                                                                • begin
                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • catch
                                                                • char
                                                                • checked
                                                                • class
                                                                • const
                                                                • continue
                                                                • decimal
                                                                • default
                                                                • delegate
                                                                • do
                                                                • done
                                                                • double
                                                                • downcast
                                                                • downto
                                                                • dynamic
                                                                • elif
                                                                • else
                                                                • end
                                                                • enum
                                                                • event
                                                                • exception
                                                                • explicit
                                                                • extern
                                                                • false
                                                                • finally
                                                                • fixed
                                                                • float
                                                                • for
                                                                • foreach
                                                                • fun
                                                                • function
                                                                • if
                                                                • in
                                                                • inherit
                                                                • inline
                                                                • int
                                                                • interface
                                                                • internal
                                                                • is
                                                                • lazy
                                                                • let
                                                                • let!
                                                                • localVarFileParams
                                                                • localVarFormParams
                                                                • localVarHeaderParams
                                                                • localVarHttpContentType
                                                                • localVarHttpContentTypes
                                                                • localVarHttpHeaderAccept
                                                                • localVarHttpHeaderAccepts
                                                                • localVarPath
                                                                • localVarPathParams
                                                                • localVarPostBody
                                                                • localVarQueryParams
                                                                • localVarResponse
                                                                • localVarStatusCode
                                                                • lock
                                                                • match
                                                                • match!
                                                                • member
                                                                • module
                                                                • mutable
                                                                • namespace
                                                                • new
                                                                • not
                                                                • null
                                                                • of
                                                                • open
                                                                • option
                                                                • or
                                                                • override
                                                                • params
                                                                • private
                                                                • public
                                                                • raise
                                                                • rec
                                                                • return
                                                                • return!
                                                                • sealed
                                                                • select
                                                                • static
                                                                • string
                                                                • struct
                                                                • then
                                                                • to
                                                                • true
                                                                • try
                                                                • type
                                                                • upcast
                                                                • use
                                                                • use!
                                                                • val
                                                                • void
                                                                • volatile
                                                                • when
                                                                • while
                                                                • with
                                                                • yield
                                                                • yield!

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✗ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✗OAS2,OAS3
                                                                BasePath✗OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/fsharp-giraffe-server/index.html b/docs/generators/fsharp-giraffe-server/index.html index d0512713dcb..180c0fb3c81 100644 --- a/docs/generators/fsharp-giraffe-server/index.html +++ b/docs/generators/fsharp-giraffe-server/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for fsharp-giraffe-server

                                                                OptionDescriptionValuesDefault
                                                                buildTargetTarget the build for a program or library.program
                                                                generateBodyGenerates method body.true
                                                                licenseNameThe name of the licenseNoLicense
                                                                licenseUrlThe URL of the licensehttp://localhost
                                                                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                                                                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                                                                packageGuidThe GUID that will be associated with the C# projectnull
                                                                packageNameF# module name (convention: Title.Case).OpenAPI
                                                                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                                                                packageVersionF# package version.1.0.0
                                                                returnICollectionReturn ICollection<T> instead of the concrete type.false
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                sourceFoldersource folder for generated codeOpenAPI/src
                                                                useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                                                useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                                                useSwashbuckleUses the Swashbuckle.AspNetCore NuGet package for documentation.false

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                IDictionarySystem.Collections.Generic

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By
                                                                arraylist
                                                                listlist
                                                                mapIDictionary

                                                                LANGUAGE PRIMITIVES

                                                                • Collection
                                                                • DataTimeOffset
                                                                • DateTime
                                                                • Dictionary
                                                                • Double
                                                                • ICollection
                                                                • Int32
                                                                • Int64
                                                                • List
                                                                • String
                                                                • System.IO.Stream
                                                                • bool
                                                                • byte[]
                                                                • char
                                                                • decimal
                                                                • dict
                                                                • double
                                                                • float
                                                                • float32
                                                                • int
                                                                • int16
                                                                • int64
                                                                • list
                                                                • nativeint
                                                                • obj
                                                                • seq
                                                                • single
                                                                • string
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • unativeint

                                                                RESERVED WORDS

                                                                • abstract
                                                                • and
                                                                • as
                                                                • assert
                                                                • async
                                                                • await
                                                                • base
                                                                • begin
                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • catch
                                                                • char
                                                                • checked
                                                                • class
                                                                • const
                                                                • continue
                                                                • decimal
                                                                • default
                                                                • delegate
                                                                • do
                                                                • done
                                                                • double
                                                                • downcast
                                                                • downto
                                                                • dynamic
                                                                • elif
                                                                • else
                                                                • end
                                                                • enum
                                                                • event
                                                                • exception
                                                                • explicit
                                                                • extern
                                                                • false
                                                                • finally
                                                                • fixed
                                                                • float
                                                                • for
                                                                • foreach
                                                                • fun
                                                                • function
                                                                • if
                                                                • in
                                                                • inherit
                                                                • inline
                                                                • int
                                                                • interface
                                                                • internal
                                                                • is
                                                                • lazy
                                                                • let
                                                                • let!
                                                                • localVarFileParams
                                                                • localVarFormParams
                                                                • localVarHeaderParams
                                                                • localVarHttpContentType
                                                                • localVarHttpContentTypes
                                                                • localVarHttpHeaderAccept
                                                                • localVarHttpHeaderAccepts
                                                                • localVarPath
                                                                • localVarPathParams
                                                                • localVarPostBody
                                                                • localVarQueryParams
                                                                • localVarResponse
                                                                • localVarStatusCode
                                                                • lock
                                                                • match
                                                                • match!
                                                                • member
                                                                • module
                                                                • mutable
                                                                • namespace
                                                                • new
                                                                • not
                                                                • null
                                                                • of
                                                                • open
                                                                • option
                                                                • or
                                                                • override
                                                                • params
                                                                • private
                                                                • public
                                                                • raise
                                                                • rec
                                                                • return
                                                                • return!
                                                                • sealed
                                                                • select
                                                                • static
                                                                • string
                                                                • struct
                                                                • then
                                                                • to
                                                                • true
                                                                • try
                                                                • type
                                                                • upcast
                                                                • use
                                                                • use!
                                                                • val
                                                                • void
                                                                • volatile
                                                                • when
                                                                • while
                                                                • with
                                                                • yield
                                                                • yield!

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✓OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✓OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✓OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✓OAS2,OAS3
                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for fsharp-giraffe-server

                                                                OptionDescriptionValuesDefault
                                                                buildTargetTarget the build for a program or library.program
                                                                generateBodyGenerates method body.true
                                                                licenseNameThe name of the licenseNoLicense
                                                                licenseUrlThe URL of the licensehttp://localhost
                                                                packageAuthorsSpecifies Authors property in the .NET Core project file.OpenAPI
                                                                packageCopyrightSpecifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.No Copyright
                                                                packageGuidThe GUID that will be associated with the C# projectnull
                                                                packageNameF# module name (convention: Title.Case).OpenAPI
                                                                packageTitleSpecifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.OpenAPI Library
                                                                packageVersionF# package version.1.0.0
                                                                returnICollectionReturn ICollection<T> instead of the concrete type.false
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                sourceFoldersource folder for generated codeOpenAPI/src
                                                                useCollectionDeserialize array types to Collection<T> instead of List<T>.false
                                                                useDateTimeOffsetUse DateTimeOffset to model date-time propertiesfalse
                                                                useSwashbuckleUses the Swashbuckle.AspNetCore NuGet package for documentation.false

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                IDictionarySystem.Collections.Generic

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By
                                                                arraylist
                                                                listlist
                                                                mapIDictionary

                                                                LANGUAGE PRIMITIVES

                                                                • Collection
                                                                • DataTimeOffset
                                                                • DateTime
                                                                • Dictionary
                                                                • Double
                                                                • ICollection
                                                                • Int32
                                                                • Int64
                                                                • List
                                                                • String
                                                                • System.IO.Stream
                                                                • bool
                                                                • byte[]
                                                                • char
                                                                • decimal
                                                                • dict
                                                                • double
                                                                • float
                                                                • float32
                                                                • int
                                                                • int16
                                                                • int64
                                                                • list
                                                                • nativeint
                                                                • obj
                                                                • seq
                                                                • single
                                                                • string
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • unativeint

                                                                RESERVED WORDS

                                                                • abstract
                                                                • and
                                                                • as
                                                                • assert
                                                                • async
                                                                • await
                                                                • base
                                                                • begin
                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • catch
                                                                • char
                                                                • checked
                                                                • class
                                                                • const
                                                                • continue
                                                                • decimal
                                                                • default
                                                                • delegate
                                                                • do
                                                                • done
                                                                • double
                                                                • downcast
                                                                • downto
                                                                • dynamic
                                                                • elif
                                                                • else
                                                                • end
                                                                • enum
                                                                • event
                                                                • exception
                                                                • explicit
                                                                • extern
                                                                • false
                                                                • finally
                                                                • fixed
                                                                • float
                                                                • for
                                                                • foreach
                                                                • fun
                                                                • function
                                                                • if
                                                                • in
                                                                • inherit
                                                                • inline
                                                                • int
                                                                • interface
                                                                • internal
                                                                • is
                                                                • lazy
                                                                • let
                                                                • let!
                                                                • localVarFileParams
                                                                • localVarFormParams
                                                                • localVarHeaderParams
                                                                • localVarHttpContentType
                                                                • localVarHttpContentTypes
                                                                • localVarHttpHeaderAccept
                                                                • localVarHttpHeaderAccepts
                                                                • localVarPath
                                                                • localVarPathParams
                                                                • localVarPostBody
                                                                • localVarQueryParams
                                                                • localVarResponse
                                                                • localVarStatusCode
                                                                • lock
                                                                • match
                                                                • match!
                                                                • member
                                                                • module
                                                                • mutable
                                                                • namespace
                                                                • new
                                                                • not
                                                                • null
                                                                • of
                                                                • open
                                                                • option
                                                                • or
                                                                • override
                                                                • params
                                                                • private
                                                                • public
                                                                • raise
                                                                • rec
                                                                • return
                                                                • return!
                                                                • sealed
                                                                • select
                                                                • static
                                                                • string
                                                                • struct
                                                                • then
                                                                • to
                                                                • true
                                                                • try
                                                                • type
                                                                • upcast
                                                                • use
                                                                • use!
                                                                • val
                                                                • void
                                                                • volatile
                                                                • when
                                                                • while
                                                                • with
                                                                • yield
                                                                • yield!

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✓OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✓OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✓OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✓OAS2,OAS3
                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/go-experimental/index.html b/docs/generators/go-experimental/index.html index 8278e4c304a..77d515a60ee 100644 --- a/docs/generators/go-experimental/index.html +++ b/docs/generators/go-experimental/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for go-experimental

                                                                OptionDescriptionValuesDefault
                                                                enumClassPrefixPrefix enum with class namefalse
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                isGoSubmodulewhether the generated Go module is a submodulefalse
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                structPrefixwhether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOptsfalse
                                                                withAWSV4Signaturewhether to include AWS v4 signature supportfalse
                                                                withGoCodegenCommentwhether to include Go codegen comment to disable Go Lint and collapse by default in GitHub PRs and diffsfalse
                                                                withXmlwhether 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

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✓ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Simon Alling
                                                                +

                                                                Config Options for go-experimental

                                                                OptionDescriptionValuesDefault
                                                                enumClassPrefixPrefix enum with class namefalse
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                isGoSubmodulewhether the generated Go module is a submodulefalse
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                structPrefixwhether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOptsfalse
                                                                withAWSV4Signaturewhether to include AWS v4 signature supportfalse
                                                                withGoCodegenCommentwhether to include Go codegen comment to disable Go Lint and collapse by default in GitHub PRs and diffsfalse
                                                                withXmlwhether 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

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✓ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Simon Alling
                                                                - + - + - + diff --git a/docs/generators/go-gin-server/index.html b/docs/generators/go-gin-server/index.html index 5bb8683f461..9038276d411 100644 --- a/docs/generators/go-gin-server/index.html +++ b/docs/generators/go-gin-server/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for go-gin-server

                                                                OptionDescriptionValuesDefault
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for go-gin-server

                                                                OptionDescriptionValuesDefault
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/go-server/index.html b/docs/generators/go-server/index.html index 0431fffb7db..db8bb801cdb 100644 --- a/docs/generators/go-server/index.html +++ b/docs/generators/go-server/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for go-server

                                                                OptionDescriptionValuesDefault
                                                                featureCORSEnable Cross-Origin Resource Sharing middlewarefalse
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0
                                                                serverPortThe network port the generated server binds to8080
                                                                sourceFoldersource folder for generated codego

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for go-server

                                                                OptionDescriptionValuesDefault
                                                                featureCORSEnable Cross-Origin Resource Sharing middlewarefalse
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0
                                                                serverPortThe network port the generated server binds to8080
                                                                sourceFoldersource folder for generated codego

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/go/index.html b/docs/generators/go/index.html index 979f9121231..8e4d5fb0342 100644 --- a/docs/generators/go/index.html +++ b/docs/generators/go/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for go

                                                                OptionDescriptionValuesDefault
                                                                enumClassPrefixPrefix enum with class namefalse
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                isGoSubmodulewhether the generated Go module is a submodulefalse
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                structPrefixwhether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOptsfalse
                                                                withAWSV4Signaturewhether to include AWS v4 signature supportfalse
                                                                withGoCodegenCommentwhether to include Go codegen comment to disable Go Lint and collapse by default in GitHub PRs and diffsfalse
                                                                withXmlwhether 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

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✓ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Simon Alling
                                                                +

                                                                Config Options for go

                                                                OptionDescriptionValuesDefault
                                                                enumClassPrefixPrefix enum with class namefalse
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                isGoSubmodulewhether the generated Go module is a submodulefalse
                                                                packageNameGo package name (convention: lowercase).openapi
                                                                packageVersionGo package version.1.0.0
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                structPrefixwhether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOptsfalse
                                                                withAWSV4Signaturewhether to include AWS v4 signature supportfalse
                                                                withGoCodegenCommentwhether to include Go codegen comment to disable Go Lint and collapse by default in GitHub PRs and diffsfalse
                                                                withXmlwhether 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

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • bool
                                                                • byte
                                                                • complex128
                                                                • complex64
                                                                • float32
                                                                • float64
                                                                • int
                                                                • int32
                                                                • int64
                                                                • rune
                                                                • string
                                                                • uint
                                                                • uint32
                                                                • uint64

                                                                RESERVED WORDS

                                                                • bool
                                                                • break
                                                                • byte
                                                                • case
                                                                • chan
                                                                • complex128
                                                                • complex64
                                                                • const
                                                                • continue
                                                                • default
                                                                • defer
                                                                • else
                                                                • error
                                                                • fallthrough
                                                                • float32
                                                                • float64
                                                                • for
                                                                • func
                                                                • go
                                                                • goto
                                                                • if
                                                                • import
                                                                • int
                                                                • int16
                                                                • int32
                                                                • int64
                                                                • int8
                                                                • interface
                                                                • map
                                                                • nil
                                                                • package
                                                                • range
                                                                • return
                                                                • rune
                                                                • select
                                                                • string
                                                                • struct
                                                                • switch
                                                                • type
                                                                • uint
                                                                • uint16
                                                                • uint32
                                                                • uint64
                                                                • uint8
                                                                • uintptr
                                                                • var

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✓ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Simon Alling
                                                                - + - + - + diff --git a/docs/generators/graphql-nodejs-express-server/index.html b/docs/generators/graphql-nodejs-express-server/index.html index df1bfbd6ec7..f2245beb194 100644 --- a/docs/generators/graphql-nodejs-express-server/index.html +++ b/docs/generators/graphql-nodejs-express-server/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for graphql-nodejs-express-server

                                                                OptionDescriptionValuesDefault
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGraphQL Node.js Express server package name (convention: lowercase).openapi3graphql-server
                                                                packageVersionGraphQL Node.js Express server package version.1.0.0

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Arrayjava.util.List
                                                                ArrayListjava.util.ArrayList
                                                                BigDecimaljava.math.BigDecimal
                                                                Datejava.util.Date
                                                                DateTimeorg.joda.time.*
                                                                Filejava.io.File
                                                                HashMapjava.util.HashMap
                                                                Listjava.util.*
                                                                LocalDateorg.joda.time.*
                                                                LocalDateTimeorg.joda.time.*
                                                                LocalTimeorg.joda.time.*
                                                                Mapjava.util.Map
                                                                Setjava.util.*
                                                                Timestampjava.sql.Timestamp
                                                                URIjava.net.URI
                                                                UUIDjava.util.UUID

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Boolean
                                                                • Float
                                                                • ID
                                                                • Int
                                                                • String
                                                                • null

                                                                RESERVED WORDS

                                                                • boolean
                                                                • float
                                                                • id
                                                                • implements
                                                                • int
                                                                • interface
                                                                • null
                                                                • query
                                                                • string
                                                                • type
                                                                • union

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for graphql-nodejs-express-server

                                                                OptionDescriptionValuesDefault
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGraphQL Node.js Express server package name (convention: lowercase).openapi3graphql-server
                                                                packageVersionGraphQL Node.js Express server package version.1.0.0

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Arrayjava.util.List
                                                                ArrayListjava.util.ArrayList
                                                                BigDecimaljava.math.BigDecimal
                                                                Datejava.util.Date
                                                                DateTimeorg.joda.time.*
                                                                Filejava.io.File
                                                                HashMapjava.util.HashMap
                                                                Listjava.util.*
                                                                LocalDateorg.joda.time.*
                                                                LocalDateTimeorg.joda.time.*
                                                                LocalTimeorg.joda.time.*
                                                                Mapjava.util.Map
                                                                Setjava.util.*
                                                                Timestampjava.sql.Timestamp
                                                                URIjava.net.URI
                                                                UUIDjava.util.UUID

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Boolean
                                                                • Float
                                                                • ID
                                                                • Int
                                                                • String
                                                                • null

                                                                RESERVED WORDS

                                                                • boolean
                                                                • float
                                                                • id
                                                                • implements
                                                                • int
                                                                • interface
                                                                • null
                                                                • query
                                                                • string
                                                                • type
                                                                • union

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/graphql-schema/index.html b/docs/generators/graphql-schema/index.html index 57d77e790f5..df34868819b 100644 --- a/docs/generators/graphql-schema/index.html +++ b/docs/generators/graphql-schema/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for graphql-schema

                                                                OptionDescriptionValuesDefault
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGraphQL package name (convention: lowercase).openapi2graphql
                                                                packageVersionGraphQL package version.1.0.0

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Arrayjava.util.List
                                                                ArrayListjava.util.ArrayList
                                                                BigDecimaljava.math.BigDecimal
                                                                Datejava.util.Date
                                                                DateTimeorg.joda.time.*
                                                                Filejava.io.File
                                                                HashMapjava.util.HashMap
                                                                Listjava.util.*
                                                                LocalDateorg.joda.time.*
                                                                LocalDateTimeorg.joda.time.*
                                                                LocalTimeorg.joda.time.*
                                                                Mapjava.util.Map
                                                                Setjava.util.*
                                                                Timestampjava.sql.Timestamp
                                                                URIjava.net.URI
                                                                UUIDjava.util.UUID

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Boolean
                                                                • Float
                                                                • ID
                                                                • Int
                                                                • String
                                                                • null

                                                                RESERVED WORDS

                                                                • boolean
                                                                • float
                                                                • id
                                                                • implements
                                                                • int
                                                                • interface
                                                                • null
                                                                • query
                                                                • string
                                                                • type
                                                                • union

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✗ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for graphql-schema

                                                                OptionDescriptionValuesDefault
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                packageNameGraphQL package name (convention: lowercase).openapi2graphql
                                                                packageVersionGraphQL package version.1.0.0

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Arrayjava.util.List
                                                                ArrayListjava.util.ArrayList
                                                                BigDecimaljava.math.BigDecimal
                                                                Datejava.util.Date
                                                                DateTimeorg.joda.time.*
                                                                Filejava.io.File
                                                                HashMapjava.util.HashMap
                                                                Listjava.util.*
                                                                LocalDateorg.joda.time.*
                                                                LocalDateTimeorg.joda.time.*
                                                                LocalTimeorg.joda.time.*
                                                                Mapjava.util.Map
                                                                Setjava.util.*
                                                                Timestampjava.sql.Timestamp
                                                                URIjava.net.URI
                                                                UUIDjava.util.UUID

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Boolean
                                                                • Float
                                                                • ID
                                                                • Int
                                                                • String
                                                                • null

                                                                RESERVED WORDS

                                                                • boolean
                                                                • float
                                                                • id
                                                                • implements
                                                                • int
                                                                • interface
                                                                • null
                                                                • query
                                                                • string
                                                                • type
                                                                • union

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✗ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/groovy/index.html b/docs/generators/groovy/index.html index 48ab7b51491..5a51dc46a20 100644 --- a/docs/generators/groovy/index.html +++ b/docs/generators/groovy/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for groovy

                                                                OptionDescriptionValuesDefault
                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-groovy
                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                dateLibraryOption. 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)
                                                                		legacy
                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                true
                                                                Use Java 8 classes such as Base64
                                                                false
                                                                Various third party libraries as needed
                                                                		false
                                                                licenseNameThe name of the licenseUnlicense
                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                snapshotVersionUses a SNAPSHOT version.
                                                                true
                                                                Use a SnapShot Version
                                                                false
                                                                Use a Release Version
                                                                		null
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                sourceFoldersource folder for generated codesrc/main/groovy
                                                                withXmlwhether 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

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Arrayjava.util.List
                                                                ArrayListjava.util.ArrayList
                                                                BigDecimaljava.math.BigDecimal
                                                                Datejava.util.Date
                                                                DateTimeorg.joda.time.*
                                                                Filejava.io.File
                                                                HashMapjava.util.HashMap
                                                                Listjava.util.*
                                                                LocalDateorg.joda.time.*
                                                                LocalDateTimeorg.joda.time.*
                                                                LocalTimeorg.joda.time.*
                                                                Mapjava.util.Map
                                                                Setjava.util.*
                                                                Timestampjava.sql.Timestamp
                                                                URIjava.net.URI
                                                                UUIDjava.util.UUID

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By
                                                                arrayArrayList
                                                                mapHashMap

                                                                LANGUAGE PRIMITIVES

                                                                • ArrayList
                                                                • Boolean
                                                                • Date
                                                                • Double
                                                                • File
                                                                • Float
                                                                • Integer
                                                                • Long
                                                                • Map
                                                                • Object
                                                                • String
                                                                • boolean
                                                                • byte[]

                                                                RESERVED WORDS

                                                                • abstract
                                                                • apiclient
                                                                • apiexception
                                                                • apiresponse
                                                                • assert
                                                                • boolean
                                                                • break
                                                                • byte
                                                                • case
                                                                • catch
                                                                • char
                                                                • class
                                                                • configuration
                                                                • const
                                                                • continue
                                                                • default
                                                                • do
                                                                • double
                                                                • else
                                                                • enum
                                                                • extends
                                                                • final
                                                                • finally
                                                                • float
                                                                • for
                                                                • goto
                                                                • if
                                                                • implements
                                                                • import
                                                                • instanceof
                                                                • int
                                                                • interface
                                                                • localreturntype
                                                                • localvaraccept
                                                                • localvaraccepts
                                                                • localvarauthnames
                                                                • localvarcollectionqueryparams
                                                                • localvarcontenttype
                                                                • localvarcontenttypes
                                                                • localvarcookieparams
                                                                • localvarformparams
                                                                • localvarheaderparams
                                                                • localvarpath
                                                                • localvarpostbody
                                                                • localvarqueryparams
                                                                • long
                                                                • native
                                                                • new
                                                                • null
                                                                • object
                                                                • package
                                                                • private
                                                                • protected
                                                                • public
                                                                • return
                                                                • short
                                                                • static
                                                                • strictfp
                                                                • stringutil
                                                                • super
                                                                • switch
                                                                • synchronized
                                                                • this
                                                                • throw
                                                                • throws
                                                                • transient
                                                                • try
                                                                • void
                                                                • volatile
                                                                • while

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for groovy

                                                                OptionDescriptionValuesDefault
                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-groovy
                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                dateLibraryOption. 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)
                                                                		legacy
                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                true
                                                                Use Java 8 classes such as Base64
                                                                false
                                                                Various third party libraries as needed
                                                                		false
                                                                licenseNameThe name of the licenseUnlicense
                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                snapshotVersionUses a SNAPSHOT version.
                                                                true
                                                                Use a SnapShot Version
                                                                false
                                                                Use a Release Version
                                                                		null
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                sourceFoldersource folder for generated codesrc/main/groovy
                                                                withXmlwhether 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

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Arrayjava.util.List
                                                                ArrayListjava.util.ArrayList
                                                                BigDecimaljava.math.BigDecimal
                                                                Datejava.util.Date
                                                                DateTimeorg.joda.time.*
                                                                Filejava.io.File
                                                                HashMapjava.util.HashMap
                                                                Listjava.util.*
                                                                LocalDateorg.joda.time.*
                                                                LocalDateTimeorg.joda.time.*
                                                                LocalTimeorg.joda.time.*
                                                                Mapjava.util.Map
                                                                Setjava.util.*
                                                                Timestampjava.sql.Timestamp
                                                                URIjava.net.URI
                                                                UUIDjava.util.UUID

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By
                                                                arrayArrayList
                                                                mapHashMap

                                                                LANGUAGE PRIMITIVES

                                                                • ArrayList
                                                                • Boolean
                                                                • Date
                                                                • Double
                                                                • File
                                                                • Float
                                                                • Integer
                                                                • Long
                                                                • Map
                                                                • Object
                                                                • String
                                                                • boolean
                                                                • byte[]

                                                                RESERVED WORDS

                                                                • abstract
                                                                • apiclient
                                                                • apiexception
                                                                • apiresponse
                                                                • assert
                                                                • boolean
                                                                • break
                                                                • byte
                                                                • case
                                                                • catch
                                                                • char
                                                                • class
                                                                • configuration
                                                                • const
                                                                • continue
                                                                • default
                                                                • do
                                                                • double
                                                                • else
                                                                • enum
                                                                • extends
                                                                • final
                                                                • finally
                                                                • float
                                                                • for
                                                                • goto
                                                                • if
                                                                • implements
                                                                • import
                                                                • instanceof
                                                                • int
                                                                • interface
                                                                • localreturntype
                                                                • localvaraccept
                                                                • localvaraccepts
                                                                • localvarauthnames
                                                                • localvarcollectionqueryparams
                                                                • localvarcontenttype
                                                                • localvarcontenttypes
                                                                • localvarcookieparams
                                                                • localvarformparams
                                                                • localvarheaderparams
                                                                • localvarpath
                                                                • localvarpostbody
                                                                • localvarqueryparams
                                                                • long
                                                                • native
                                                                • new
                                                                • null
                                                                • object
                                                                • package
                                                                • private
                                                                • protected
                                                                • public
                                                                • return
                                                                • short
                                                                • static
                                                                • strictfp
                                                                • stringutil
                                                                • super
                                                                • switch
                                                                • synchronized
                                                                • this
                                                                • throw
                                                                • throws
                                                                • transient
                                                                • try
                                                                • void
                                                                • volatile
                                                                • while

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✗OAS2,OAS3
                                                                ApiKey✗OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✗OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/haskell-http-client/index.html b/docs/generators/haskell-http-client/index.html index da8101e30d9..cabbe5c7579 100644 --- a/docs/generators/haskell-http-client/index.html +++ b/docs/generators/haskell-http-client/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for haskell-http-client

                                                                OptionDescriptionValuesDefault
                                                                allowFromJsonNullsallow JSON Null during model decoding from JSONtrue
                                                                allowNonUniqueOperationIdsallow different API modules to contain the same operationId. Each API must be imported qualifiedfalse
                                                                allowToJsonNullsallow emitting JSON Null during model encoding to JSONfalse
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                baseModuleSet the base module namespacenull
                                                                cabalPackageSet the cabal package name, which consists of one or more alphanumeric words separated by hyphensnull
                                                                cabalVersionSet the cabal version number, consisting of a sequence of one or more integers separated by dotsnull
                                                                configTypeSet the name of the type used for configurationnull
                                                                customTestInstanceModuletest module used to provide typeclass instances for types not known by the generatornull
                                                                dateFormatformat string used to parse/render a date%Y-%m-%d
                                                                dateTimeFormatformat string used to parse/render a datetimenull
                                                                dateTimeParseFormatoverrides the format string used to parse a datetimenull
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                generateEnumsGenerate specific datatypes for OpenAPI enumstrue
                                                                generateFormUrlEncodedInstancesGenerate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencodedtrue
                                                                generateLensesGenerate Lens optics for Modelstrue
                                                                generateModelConstructorsGenerate smart constructors (only supply required fields) for modelstrue
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                inlineMimeTypesInline (hardcode) the content-type and accept parameters on operations, when there is only 1 optiontrue
                                                                modelDerivingAdditional classes to include in the deriving() clause of Modelsnull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                requestTypeSet the name of the type used to generate requestsnull
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                strictFieldsAdd strictness annotations to all model fieldstrue
                                                                useKatipSets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-loggertrue

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Bool
                                                                • Char
                                                                • Double
                                                                • FilePath
                                                                • Float
                                                                • Int
                                                                • Integer
                                                                • List
                                                                • String
                                                                • Text

                                                                RESERVED WORDS

                                                                • accept
                                                                • as
                                                                • case
                                                                • class
                                                                • contenttype
                                                                • data
                                                                • default
                                                                • deriving
                                                                • do
                                                                • else
                                                                • family
                                                                • forall
                                                                • foreign
                                                                • hiding
                                                                • if
                                                                • import
                                                                • in
                                                                • infix
                                                                • infixl
                                                                • infixr
                                                                • instance
                                                                • let
                                                                • mdo
                                                                • module
                                                                • newtype
                                                                • of
                                                                • proc
                                                                • pure
                                                                • qualified
                                                                • rec
                                                                • return
                                                                • then
                                                                • type
                                                                • where

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✓ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for haskell-http-client

                                                                OptionDescriptionValuesDefault
                                                                allowFromJsonNullsallow JSON Null during model decoding from JSONtrue
                                                                allowNonUniqueOperationIdsallow different API modules to contain the same operationId. Each API must be imported qualifiedfalse
                                                                allowToJsonNullsallow emitting JSON Null during model encoding to JSONfalse
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                baseModuleSet the base module namespacenull
                                                                cabalPackageSet the cabal package name, which consists of one or more alphanumeric words separated by hyphensnull
                                                                cabalVersionSet the cabal version number, consisting of a sequence of one or more integers separated by dotsnull
                                                                configTypeSet the name of the type used for configurationnull
                                                                customTestInstanceModuletest module used to provide typeclass instances for types not known by the generatornull
                                                                dateFormatformat string used to parse/render a date%Y-%m-%d
                                                                dateTimeFormatformat string used to parse/render a datetimenull
                                                                dateTimeParseFormatoverrides the format string used to parse a datetimenull
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                generateEnumsGenerate specific datatypes for OpenAPI enumstrue
                                                                generateFormUrlEncodedInstancesGenerate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencodedtrue
                                                                generateLensesGenerate Lens optics for Modelstrue
                                                                generateModelConstructorsGenerate smart constructors (only supply required fields) for modelstrue
                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                inlineMimeTypesInline (hardcode) the content-type and accept parameters on operations, when there is only 1 optiontrue
                                                                modelDerivingAdditional classes to include in the deriving() clause of Modelsnull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                requestTypeSet the name of the type used to generate requestsnull
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                strictFieldsAdd strictness annotations to all model fieldstrue
                                                                useKatipSets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-loggertrue

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Bool
                                                                • Char
                                                                • Double
                                                                • FilePath
                                                                • Float
                                                                • Int
                                                                • Integer
                                                                • List
                                                                • String
                                                                • Text

                                                                RESERVED WORDS

                                                                • accept
                                                                • as
                                                                • case
                                                                • class
                                                                • contenttype
                                                                • data
                                                                • default
                                                                • deriving
                                                                • do
                                                                • else
                                                                • family
                                                                • forall
                                                                • foreign
                                                                • hiding
                                                                • if
                                                                • import
                                                                • in
                                                                • infix
                                                                • infixl
                                                                • infixr
                                                                • instance
                                                                • let
                                                                • mdo
                                                                • module
                                                                • newtype
                                                                • of
                                                                • proc
                                                                • pure
                                                                • qualified
                                                                • rec
                                                                • return
                                                                • then
                                                                • type
                                                                • where

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✓ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✓ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✗OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/haskell/index.html b/docs/generators/haskell/index.html index 2747d700f51..dc6966a1d1b 100644 --- a/docs/generators/haskell/index.html +++ b/docs/generators/haskell/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for haskell

                                                                OptionDescriptionValuesDefault
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                apiPackagepackage for generated api classesnull
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                modelPackagepackage for generated modelsnull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                serveStaticserve will serve files from the directory 'static'.true
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Mapqualified Data.Map as Map

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Bool
                                                                • Char
                                                                • Double
                                                                • FilePath
                                                                • Float
                                                                • Int
                                                                • Integer
                                                                • List
                                                                • String

                                                                RESERVED WORDS

                                                                • as
                                                                • case
                                                                • class
                                                                • data
                                                                • default
                                                                • deriving
                                                                • do
                                                                • else
                                                                • family
                                                                • forall
                                                                • foreign
                                                                • hiding
                                                                • if
                                                                • import
                                                                • in
                                                                • infix
                                                                • infixl
                                                                • infixr
                                                                • instance
                                                                • let
                                                                • mdo
                                                                • module
                                                                • newtype
                                                                • of
                                                                • proc
                                                                • qualified
                                                                • rec
                                                                • then
                                                                • type
                                                                • where

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                +

                                                                Config Options for haskell

                                                                OptionDescriptionValuesDefault
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                apiPackagepackage for generated api classesnull
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                modelPackagepackage for generated modelsnull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                serveStaticserve will serve files from the directory 'static'.true
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                IMPORT MAPPING

                                                                Type/AliasImports
                                                                Mapqualified Data.Map as Map

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                • Bool
                                                                • Char
                                                                • Double
                                                                • FilePath
                                                                • Float
                                                                • Int
                                                                • Integer
                                                                • List
                                                                • String

                                                                RESERVED WORDS

                                                                • as
                                                                • case
                                                                • class
                                                                • data
                                                                • default
                                                                • deriving
                                                                • do
                                                                • else
                                                                • family
                                                                • forall
                                                                • foreign
                                                                • hiding
                                                                • if
                                                                • import
                                                                • in
                                                                • infix
                                                                • infixl
                                                                • infixr
                                                                • instance
                                                                • let
                                                                • mdo
                                                                • module
                                                                • newtype
                                                                • of
                                                                • proc
                                                                • qualified
                                                                • rec
                                                                • then
                                                                • type
                                                                • where

                                                                FEATURE SET

                                                                Client Modification Feature

                                                                NameSupportedDefined By
                                                                BasePath✗ToolingExtension
                                                                Authorizations✗ToolingExtension
                                                                UserAgent✗ToolingExtension

                                                                Data Type Feature

                                                                NameSupportedDefined By
                                                                Custom✗OAS2,OAS3
                                                                Int32✓OAS2,OAS3
                                                                Int64✓OAS2,OAS3
                                                                Float✓OAS2,OAS3
                                                                Double✓OAS2,OAS3
                                                                Decimal✓ToolingExtension
                                                                String✓OAS2,OAS3
                                                                Byte✓OAS2,OAS3
                                                                Binary✓OAS2,OAS3
                                                                Boolean✓OAS2,OAS3
                                                                Date✓OAS2,OAS3
                                                                DateTime✓OAS2,OAS3
                                                                Password✓OAS2,OAS3
                                                                File✓OAS2
                                                                Array✓OAS2,OAS3
                                                                Maps✓ToolingExtension
                                                                CollectionFormat✓OAS2
                                                                CollectionFormatMulti✓OAS2
                                                                Enum✓OAS2,OAS3
                                                                ArrayOfEnum✓ToolingExtension
                                                                ArrayOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                MapOfEnum✓ToolingExtension
                                                                MapOfModel✓ToolingExtension
                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                Documentation Feature

                                                                NameSupportedDefined By
                                                                Readme✓ToolingExtension
                                                                Model✓ToolingExtension
                                                                Api✓ToolingExtension

                                                                Global Feature

                                                                NameSupportedDefined By
                                                                Host✓OAS2,OAS3
                                                                BasePath✓OAS2,OAS3
                                                                Info✓OAS2,OAS3
                                                                Schemes✗OAS2,OAS3
                                                                PartialSchemes✓OAS2,OAS3
                                                                Consumes✓OAS2
                                                                Produces✓OAS2
                                                                ExternalDocumentation✓OAS2,OAS3
                                                                Examples✓OAS2,OAS3
                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                MultiServer✗OAS3
                                                                ParameterizedServer✗OAS3
                                                                ParameterStyling✗OAS3
                                                                Callbacks✗OAS3
                                                                LinkObjects✗OAS3

                                                                Parameter Feature

                                                                NameSupportedDefined By
                                                                Path✓OAS2,OAS3
                                                                Query✓OAS2,OAS3
                                                                Header✓OAS2,OAS3
                                                                Body✓OAS2
                                                                FormUnencoded✓OAS2
                                                                FormMultipart✓OAS2
                                                                Cookie✓OAS3

                                                                Schema Support Feature

                                                                NameSupportedDefined By
                                                                Simple✓OAS2,OAS3
                                                                Composite✓OAS2,OAS3
                                                                Polymorphism✗OAS2,OAS3
                                                                Union✗OAS3

                                                                Security Feature

                                                                NameSupportedDefined By
                                                                BasicAuth✓OAS2,OAS3
                                                                ApiKey✓OAS2,OAS3
                                                                OpenIDConnect✗OAS3
                                                                BearerToken✗OAS3
                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                OAuth2_Password✗OAS2,OAS3
                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                Wire Format Feature

                                                                NameSupportedDefined By
                                                                JSON✓OAS2,OAS3
                                                                XML✓OAS2,OAS3
                                                                PROTOBUF✗ToolingExtension
                                                                Custom✗OAS2,OAS3
                                                                Edit this page
                                                                Last updated on by Jim Schubert
                                                                - + - + - + diff --git a/docs/generators/html/index.html b/docs/generators/html/index.html index 9fa6399bc2a..b2803acccfd 100644 --- a/docs/generators/html/index.html +++ b/docs/generators/html/index.html @@ -21,26 +21,26 @@ - +
                                                                -

                                                                Config Options for html

                                                                OptionDescriptionValuesDefault
                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                appDescriptiondescription of the applicationnull
                                                                appNameshort name of the applicationnull
                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                groupIdgroupId in generated pom.xmlnull
                                                                infoEmailan email address to contact for inquiries about the applicationnull
                                                                infoUrla URL where users can get more information about the applicationnull
                                                                invokerPackageroot package for generated codenull
                                                                licenseInfoa short description of the licensenull
                                                                licenseUrla URL pointing to the full licensenull
                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                IMPORT MAPPING

                                                                Type/AliasImports

                                                                INSTANTIATION TYPES

                                                                Type/AliasInstantiated By

                                                                LANGUAGE PRIMITIVES

                                                                  RESERVED WORDS

                                                                    FEATURE SET

                                                                    Client Modification Feature

                                                                    NameSupportedDefined By
                                                                    BasePath✗ToolingExtension
                                                                    Authorizations✗ToolingExtension
                                                                    UserAgent✗ToolingExtension

                                                                    Data Type Feature

                                                                    NameSupportedDefined By
                                                                    Custom✓OAS2,OAS3
                                                                    Int32✓OAS2,OAS3
                                                                    Int64✓OAS2,OAS3
                                                                    Float✓OAS2,OAS3
                                                                    Double✓OAS2,OAS3
                                                                    Decimal✓ToolingExtension
                                                                    String✓OAS2,OAS3
                                                                    Byte✓OAS2,OAS3
                                                                    Binary✓OAS2,OAS3
                                                                    Boolean✓OAS2,OAS3
                                                                    Date✓OAS2,OAS3
                                                                    DateTime✓OAS2,OAS3
                                                                    Password✓OAS2,OAS3
                                                                    File✓OAS2
                                                                    Array✓OAS2,OAS3
                                                                    Maps✓ToolingExtension
                                                                    CollectionFormat✓OAS2
                                                                    CollectionFormatMulti✓OAS2
                                                                    Enum✓OAS2,OAS3
                                                                    ArrayOfEnum✓ToolingExtension
                                                                    ArrayOfModel✓ToolingExtension
                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                    MapOfEnum✓ToolingExtension
                                                                    MapOfModel✓ToolingExtension
                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                    Documentation Feature

                                                                    NameSupportedDefined By
                                                                    Readme✓ToolingExtension
                                                                    Model✓ToolingExtension
                                                                    Api✓ToolingExtension

                                                                    Global Feature

                                                                    NameSupportedDefined By
                                                                    Host✓OAS2,OAS3
                                                                    BasePath✓OAS2,OAS3
                                                                    Info✓OAS2,OAS3
                                                                    Schemes✓OAS2,OAS3
                                                                    PartialSchemes✓OAS2,OAS3
                                                                    Consumes✓OAS2
                                                                    Produces✓OAS2
                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                    Examples✓OAS2,OAS3
                                                                    XMLStructureDefinitions✓OAS2,OAS3
                                                                    MultiServer✓OAS3
                                                                    ParameterizedServer✓OAS3
                                                                    ParameterStyling✓OAS3
                                                                    Callbacks✓OAS3
                                                                    LinkObjects✓OAS3

                                                                    Parameter Feature

                                                                    NameSupportedDefined By
                                                                    Path✓OAS2,OAS3
                                                                    Query✓OAS2,OAS3
                                                                    Header✓OAS2,OAS3
                                                                    Body✓OAS2
                                                                    FormUnencoded✓OAS2
                                                                    FormMultipart✓OAS2
                                                                    Cookie✓OAS3

                                                                    Schema Support Feature

                                                                    NameSupportedDefined By
                                                                    Simple✓OAS2,OAS3
                                                                    Composite✓OAS2,OAS3
                                                                    Polymorphism✓OAS2,OAS3
                                                                    Union✓OAS3

                                                                    Security Feature

                                                                    NameSupportedDefined By
                                                                    BasicAuth✓OAS2,OAS3
                                                                    ApiKey✓OAS2,OAS3
                                                                    OpenIDConnect✓OAS3
                                                                    BearerToken✓OAS3
                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                    OAuth2_Password✓OAS2,OAS3
                                                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                                                    OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                    Wire Format Feature

                                                                    NameSupportedDefined By
                                                                    JSON✓OAS2,OAS3
                                                                    XML✓OAS2,OAS3
                                                                    PROTOBUF✓ToolingExtension
                                                                    Custom✓OAS2,OAS3
                                                                    Edit this page
                                                                    Last updated on by Jim Schubert
                                                                    +

                                                                    Config Options for html

                                                                    OptionDescriptionValuesDefault
                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                    appDescriptiondescription of the applicationnull
                                                                    appNameshort name of the applicationnull
                                                                    artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                    artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                    groupIdgroupId in generated pom.xmlnull
                                                                    infoEmailan email address to contact for inquiries about the applicationnull
                                                                    infoUrla URL where users can get more information about the applicationnull
                                                                    invokerPackageroot package for generated codenull
                                                                    licenseInfoa short description of the licensenull
                                                                    licenseUrla URL pointing to the full licensenull
                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                    IMPORT MAPPING

                                                                    Type/AliasImports

                                                                    INSTANTIATION TYPES

                                                                    Type/AliasInstantiated By

                                                                    LANGUAGE PRIMITIVES

                                                                      RESERVED WORDS

                                                                        FEATURE SET

                                                                        Client Modification Feature

                                                                        NameSupportedDefined By
                                                                        BasePath✗ToolingExtension
                                                                        Authorizations✗ToolingExtension
                                                                        UserAgent✗ToolingExtension

                                                                        Data Type Feature

                                                                        NameSupportedDefined By
                                                                        Custom✓OAS2,OAS3
                                                                        Int32✓OAS2,OAS3
                                                                        Int64✓OAS2,OAS3
                                                                        Float✓OAS2,OAS3
                                                                        Double✓OAS2,OAS3
                                                                        Decimal✓ToolingExtension
                                                                        String✓OAS2,OAS3
                                                                        Byte✓OAS2,OAS3
                                                                        Binary✓OAS2,OAS3
                                                                        Boolean✓OAS2,OAS3
                                                                        Date✓OAS2,OAS3
                                                                        DateTime✓OAS2,OAS3
                                                                        Password✓OAS2,OAS3
                                                                        File✓OAS2
                                                                        Array✓OAS2,OAS3
                                                                        Maps✓ToolingExtension
                                                                        CollectionFormat✓OAS2
                                                                        CollectionFormatMulti✓OAS2
                                                                        Enum✓OAS2,OAS3
                                                                        ArrayOfEnum✓ToolingExtension
                                                                        ArrayOfModel✓ToolingExtension
                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                        MapOfEnum✓ToolingExtension
                                                                        MapOfModel✓ToolingExtension
                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                        Documentation Feature

                                                                        NameSupportedDefined By
                                                                        Readme✓ToolingExtension
                                                                        Model✓ToolingExtension
                                                                        Api✓ToolingExtension

                                                                        Global Feature

                                                                        NameSupportedDefined By
                                                                        Host✓OAS2,OAS3
                                                                        BasePath✓OAS2,OAS3
                                                                        Info✓OAS2,OAS3
                                                                        Schemes✓OAS2,OAS3
                                                                        PartialSchemes✓OAS2,OAS3
                                                                        Consumes✓OAS2
                                                                        Produces✓OAS2
                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                        Examples✓OAS2,OAS3
                                                                        XMLStructureDefinitions✓OAS2,OAS3
                                                                        MultiServer✓OAS3
                                                                        ParameterizedServer✓OAS3
                                                                        ParameterStyling✓OAS3
                                                                        Callbacks✓OAS3
                                                                        LinkObjects✓OAS3

                                                                        Parameter Feature

                                                                        NameSupportedDefined By
                                                                        Path✓OAS2,OAS3
                                                                        Query✓OAS2,OAS3
                                                                        Header✓OAS2,OAS3
                                                                        Body✓OAS2
                                                                        FormUnencoded✓OAS2
                                                                        FormMultipart✓OAS2
                                                                        Cookie✓OAS3

                                                                        Schema Support Feature

                                                                        NameSupportedDefined By
                                                                        Simple✓OAS2,OAS3
                                                                        Composite✓OAS2,OAS3
                                                                        Polymorphism✓OAS2,OAS3
                                                                        Union✓OAS3

                                                                        Security Feature

                                                                        NameSupportedDefined By
                                                                        BasicAuth✓OAS2,OAS3
                                                                        ApiKey✓OAS2,OAS3
                                                                        OpenIDConnect✓OAS3
                                                                        BearerToken✓OAS3
                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                        OAuth2_Password✓OAS2,OAS3
                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                        Wire Format Feature

                                                                        NameSupportedDefined By
                                                                        JSON✓OAS2,OAS3
                                                                        XML✓OAS2,OAS3
                                                                        PROTOBUF✓ToolingExtension
                                                                        Custom✓OAS2,OAS3
                                                                        Edit this page
                                                                        Last updated on by Jim Schubert
                                                                        - + - + - + diff --git a/docs/generators/html2/index.html b/docs/generators/html2/index.html index 727e5782cd9..9f743b5948b 100644 --- a/docs/generators/html2/index.html +++ b/docs/generators/html2/index.html @@ -21,26 +21,26 @@ - +
                                                                        -

                                                                        Config Options for html2

                                                                        OptionDescriptionValuesDefault
                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                        appDescriptiondescription of the applicationnull
                                                                        appNameshort name of the applicationnull
                                                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                        groupIdgroupId in generated pom.xmlnull
                                                                        infoEmailan email address to contact for inquiries about the applicationnull
                                                                        infoUrla URL where users can get more information about the applicationnull
                                                                        invokerPackageroot package for generated codenull
                                                                        licenseInfoa short description of the licensenull
                                                                        licenseUrla URL pointing to the full licensenull
                                                                        packageNameC# package namenull
                                                                        perlModuleNameroot module name for generated perl codenull
                                                                        phpInvokerPackageroot package for generated php codenull
                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                        pythonPackageNamepackage name for generated python codenull
                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                        IMPORT MAPPING

                                                                        Type/AliasImports

                                                                        INSTANTIATION TYPES

                                                                        Type/AliasInstantiated By

                                                                        LANGUAGE PRIMITIVES

                                                                          RESERVED WORDS

                                                                            FEATURE SET

                                                                            Client Modification Feature

                                                                            NameSupportedDefined By
                                                                            BasePath✗ToolingExtension
                                                                            Authorizations✗ToolingExtension
                                                                            UserAgent✗ToolingExtension

                                                                            Data Type Feature

                                                                            NameSupportedDefined By
                                                                            Custom✓OAS2,OAS3
                                                                            Int32✓OAS2,OAS3
                                                                            Int64✓OAS2,OAS3
                                                                            Float✓OAS2,OAS3
                                                                            Double✓OAS2,OAS3
                                                                            Decimal✓ToolingExtension
                                                                            String✓OAS2,OAS3
                                                                            Byte✓OAS2,OAS3
                                                                            Binary✓OAS2,OAS3
                                                                            Boolean✓OAS2,OAS3
                                                                            Date✓OAS2,OAS3
                                                                            DateTime✓OAS2,OAS3
                                                                            Password✓OAS2,OAS3
                                                                            File✓OAS2
                                                                            Array✓OAS2,OAS3
                                                                            Maps✓ToolingExtension
                                                                            CollectionFormat✓OAS2
                                                                            CollectionFormatMulti✓OAS2
                                                                            Enum✓OAS2,OAS3
                                                                            ArrayOfEnum✓ToolingExtension
                                                                            ArrayOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                            MapOfEnum✓ToolingExtension
                                                                            MapOfModel✓ToolingExtension
                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                            Documentation Feature

                                                                            NameSupportedDefined By
                                                                            Readme✓ToolingExtension
                                                                            Model✓ToolingExtension
                                                                            Api✓ToolingExtension

                                                                            Global Feature

                                                                            NameSupportedDefined By
                                                                            Host✓OAS2,OAS3
                                                                            BasePath✓OAS2,OAS3
                                                                            Info✓OAS2,OAS3
                                                                            Schemes✓OAS2,OAS3
                                                                            PartialSchemes✓OAS2,OAS3
                                                                            Consumes✓OAS2
                                                                            Produces✓OAS2
                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                            Examples✓OAS2,OAS3
                                                                            XMLStructureDefinitions✓OAS2,OAS3
                                                                            MultiServer✓OAS3
                                                                            ParameterizedServer✓OAS3
                                                                            ParameterStyling✓OAS3
                                                                            Callbacks✓OAS3
                                                                            LinkObjects✓OAS3

                                                                            Parameter Feature

                                                                            NameSupportedDefined By
                                                                            Path✓OAS2,OAS3
                                                                            Query✓OAS2,OAS3
                                                                            Header✓OAS2,OAS3
                                                                            Body✓OAS2
                                                                            FormUnencoded✓OAS2
                                                                            FormMultipart✓OAS2
                                                                            Cookie✓OAS3

                                                                            Schema Support Feature

                                                                            NameSupportedDefined By
                                                                            Simple✓OAS2,OAS3
                                                                            Composite✓OAS2,OAS3
                                                                            Polymorphism✓OAS2,OAS3
                                                                            Union✓OAS3

                                                                            Security Feature

                                                                            NameSupportedDefined By
                                                                            BasicAuth✓OAS2,OAS3
                                                                            ApiKey✓OAS2,OAS3
                                                                            OpenIDConnect✓OAS3
                                                                            BearerToken✓OAS3
                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                            OAuth2_Password✓OAS2,OAS3
                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                            Wire Format Feature

                                                                            NameSupportedDefined By
                                                                            JSON✓OAS2,OAS3
                                                                            XML✓OAS2,OAS3
                                                                            PROTOBUF✓ToolingExtension
                                                                            Custom✓OAS2,OAS3
                                                                            Edit this page
                                                                            Last updated on by Jim Schubert
                                                                            +

                                                                            Config Options for html2

                                                                            OptionDescriptionValuesDefault
                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                            appDescriptiondescription of the applicationnull
                                                                            appNameshort name of the applicationnull
                                                                            artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                            artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filenamenull
                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                            groupIdgroupId in generated pom.xmlnull
                                                                            infoEmailan email address to contact for inquiries about the applicationnull
                                                                            infoUrla URL where users can get more information about the applicationnull
                                                                            invokerPackageroot package for generated codenull
                                                                            licenseInfoa short description of the licensenull
                                                                            licenseUrla URL pointing to the full licensenull
                                                                            packageNameC# package namenull
                                                                            perlModuleNameroot module name for generated perl codenull
                                                                            phpInvokerPackageroot package for generated php codenull
                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                            pythonPackageNamepackage name for generated python codenull
                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                            IMPORT MAPPING

                                                                            Type/AliasImports

                                                                            INSTANTIATION TYPES

                                                                            Type/AliasInstantiated By

                                                                            LANGUAGE PRIMITIVES

                                                                              RESERVED WORDS

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✓OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✓OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✓OAS2,OAS3
                                                                                MultiServer✓OAS3
                                                                                ParameterizedServer✓OAS3
                                                                                ParameterStyling✓OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✓OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✓OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✓OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✓ToolingExtension
                                                                                Custom✓OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/index.html b/docs/generators/index.html index 6c3cbb4389e..091c93305dd 100644 --- a/docs/generators/index.html +++ b/docs/generators/index.html @@ -21,32 +21,32 @@ - +
                                                                                -

                                                                                Generators List

                                                                                The following generators are available:

                                                                                CLIENT generators

                                                                                SERVER generators

                                                                                DOCUMENTATION generators

                                                                                SCHEMA generators

                                                                                CONFIG generators

                                                                                Edit this page
                                                                                Last updated on by William Cheng
                                                                                +

                                                                                Generators List

                                                                                The following generators are available:

                                                                                CLIENT generators

                                                                                SERVER generators

                                                                                DOCUMENTATION generators

                                                                                SCHEMA generators

                                                                                CONFIG generators

                                                                                Edit this page
                                                                                Last updated on by Keenan Pepper
                                                                                - + - + - + - + diff --git a/docs/generators/java-inflector/index.html b/docs/generators/java-inflector/index.html index f199430066e..e6042a24058 100644 --- a/docs/generators/java-inflector/index.html +++ b/docs/generators/java-inflector/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-inflector

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.controllers
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-inflector-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.controllers
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/gen/java
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-inflector

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.controllers
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-inflector-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.controllers
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/gen/java
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java-msf4j/index.html b/docs/generators/java-msf4j/index.html index d5b5b5a44a3..4b79cf1fb21 100644 --- a/docs/generators/java-msf4j/index.html +++ b/docs/generators/java-msf4j/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-msf4j

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                jersey1
                                                                                Jersey core 1.x
                                                                                jersey2
                                                                                Jersey core 2.x
                                                                                		jersey2
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-msf4j

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                jersey1
                                                                                Jersey core 1.x
                                                                                jersey2
                                                                                Jersey core 2.x
                                                                                		jersey2
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java-pkmst/index.html b/docs/generators/java-pkmst/index.html index 4eb4562a51e..54483b00f91 100644 --- a/docs/generators/java-pkmst/index.html +++ b/docs/generators/java-pkmst/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-pkmst

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classescom.prokarma.pkmst.controller
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamepkmst-microservice
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                basePackagebase package for java source codenull
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		threetenbp
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                eurekaUriEureka URInull
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlcom.prokarma
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codecom.prokarma.pkmst.controller
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelscom.prokarma.pkmst.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                pkmstInterceptorPKMST Interceptornull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serviceNameService Namenull
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                springBootAdminUriSpring-Boot URInull
                                                                                titleserver title name or client service namenull
                                                                                withXmlwhether 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
                                                                                zipkinUriZipkin URInull

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-pkmst

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classescom.prokarma.pkmst.controller
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenamepkmst-microservice
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                basePackagebase package for java source codenull
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		threetenbp
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                eurekaUriEureka URInull
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlcom.prokarma
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codecom.prokarma.pkmst.controller
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelscom.prokarma.pkmst.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                pkmstInterceptorPKMST Interceptornull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serviceNameService Namenull
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                springBootAdminUriSpring-Boot URInull
                                                                                titleserver title name or client service namenull
                                                                                withXmlwhether 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
                                                                                zipkinUriZipkin URInull

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java-play-framework/index.html b/docs/generators/java-play-framework/index.html index 6ac74fc767f..74d119bb5b5 100644 --- a/docs/generators/java-play-framework/index.html +++ b/docs/generators/java-play-framework/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-play-framework

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classescontrollers
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-playframework
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                basePackagebase package for generated codeorg.openapitools
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                configPackageconfiguration package for generated codeorg.openapitools.configuration
                                                                                controllerOnlyWhether to generate only API interface stubs without the server files.false
                                                                                dateLibraryOption. 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)
                                                                                		threetenbp
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                handleExceptionsAdd a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logictrue
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsapimodels
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated code/app
                                                                                titleserver title name or client service nameopenapi-java-playframework
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useInterfacesMakes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spectrue
                                                                                useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue
                                                                                withXmlwhether 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
                                                                                wrapCallsAdd a wrapper to each controller function to handle things like metrics, response modification, etc..true

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-play-framework

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classescontrollers
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-playframework
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                basePackagebase package for generated codeorg.openapitools
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                configPackageconfiguration package for generated codeorg.openapitools.configuration
                                                                                controllerOnlyWhether to generate only API interface stubs without the server files.false
                                                                                dateLibraryOption. 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)
                                                                                		threetenbp
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                handleExceptionsAdd a 'throw exception' to each controller function. Add also a custom error handler where you can put your custom logictrue
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsapimodels
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated code/app
                                                                                titleserver title name or client service nameopenapi-java-playframework
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useInterfacesMakes the controllerImp implements an interface to facilitate automatic completion when updating from version x to y of your spectrue
                                                                                useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue
                                                                                withXmlwhether 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
                                                                                wrapCallsAdd a wrapper to each controller function to handle things like metrics, response modification, etc..true

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java-undertow-server/index.html b/docs/generators/java-undertow-server/index.html index e945e01b638..d8dd2db466b 100644 --- a/docs/generators/java-undertow-server/index.html +++ b/docs/generators/java-undertow-server/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-undertow-server

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesnull
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-undertow-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.handler
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsnull
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-undertow-server

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesnull
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-undertow-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.handler
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsnull
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java-vertx-web/index.html b/docs/generators/java-vertx-web/index.html index d4628780c18..2ec27609651 100644 --- a/docs/generators/java-vertx-web/index.html +++ b/docs/generators/java-vertx-web/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-vertx-web

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.vertxweb.server.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-vertx-web-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0-SNAPSHOT
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.vertxweb.server
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.vertxweb.server.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-vertx-web

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.vertxweb.server.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-vertx-web-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0-SNAPSHOT
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.vertxweb.server
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.vertxweb.server.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java-vertx/index.html b/docs/generators/java-vertx/index.html index 73c16e833f4..61ff8a61fa7 100644 --- a/docs/generators/java-vertx/index.html +++ b/docs/generators/java-vertx/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java-vertx

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.server.api.verticle
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-vertx-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0-SNAPSHOT
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.server.api.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                rxInterfaceWhen specified, API interfaces are generated with RX and methods return Single<> and Comparable.false
                                                                                rxVersion2When specified in combination with rxInterface, API interfaces are generated with RxJava2.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                vertxSwaggerRouterVersionSpecify the version of the swagger router librarynull
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for java-vertx

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.server.api.verticle
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-vertx-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0-SNAPSHOT
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.server.api.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                rxInterfaceWhen specified, API interfaces are generated with RX and methods return Single<> and Comparable.false
                                                                                rxVersion2When specified in combination with rxInterface, API interfaces are generated with RxJava2.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                vertxSwaggerRouterVersionSpecify the version of the swagger router librarynull
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/java/index.html b/docs/generators/java/index.html index 745731426bc..5a2dc880cf9 100644 --- a/docs/generators/java/index.html +++ b/docs/generators/java/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for java

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.client.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
                                                                                dateLibraryOption. 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)
                                                                                		threetenbp
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                feignVersionVersion of OpenFeign: '10.x' (default), '9.x' (deprecated)false
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.client
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template) to use
                                                                                jersey1
                                                                                HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
                                                                                jersey2
                                                                                HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
                                                                                feign
                                                                                HTTP client: OpenFeign 9.x (deprecated) or 10.x (default). JSON processing: Jackson 2.9.x.
                                                                                okhttp-gson
                                                                                [DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
                                                                                retrofit
                                                                                HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
                                                                                retrofit2
                                                                                HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
                                                                                resttemplate
                                                                                HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
                                                                                webclient
                                                                                HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
                                                                                resteasy
                                                                                HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
                                                                                vertx
                                                                                HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
                                                                                google-api-client
                                                                                HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
                                                                                rest-assured
                                                                                HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
                                                                                native
                                                                                HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
                                                                                microprofile
                                                                                HTTP client: Microprofile client X.x. JSON processing: Jackson 2.9.x
                                                                                		okhttp-gson
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.client.model
                                                                                parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                performBeanValidationPerform BeanValidationfalse
                                                                                playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serializationLibrarySerialization library, default depends from the library
                                                                                jackson
                                                                                Use Jackson as serialization library
                                                                                gson
                                                                                Use Gson as serialization library
                                                                                		null
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                supportJava6Whether to support Java6 with the Jersey1 library.false
                                                                                useBeanValidationUse BeanValidation API annotationsfalse
                                                                                useGzipFeatureSend gzip-encoded requestsfalse
                                                                                usePlayWSUse Play! Async HTTP client (Play WS API)false
                                                                                useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
                                                                                useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
                                                                                useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
                                                                                useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by William Cheng
                                                                                +

                                                                                Config Options for java

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.client.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-java-client
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                caseInsensitiveResponseHeadersMake API response's headers case-insensitive. Available on okhttp-gson, jersey2 librariesfalse
                                                                                dateLibraryOption. 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)
                                                                                		threetenbp
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                feignVersionVersion of OpenFeign: '10.x' (default), '9.x' (deprecated)false
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.client
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template) to use
                                                                                jersey1
                                                                                HTTP client: Jersey client 1.19.x. JSON processing: Jackson 2.9.x. Enable Java6 support using '-DsupportJava6=true'. Enable gzip request encoding using '-DuseGzipFeature=true'. IMPORTANT NOTE: jersey 1.x is no longer actively maintained so please upgrade to 'jersey2' or other HTTP libaries instead.
                                                                                jersey2
                                                                                HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.9.x
                                                                                feign
                                                                                HTTP client: OpenFeign 9.x (deprecated) or 10.x (default). JSON processing: Jackson 2.9.x.
                                                                                okhttp-gson
                                                                                [DEFAULT] HTTP client: OkHttp 3.x. JSON processing: Gson 2.8.x. Enable Parcelable models on Android using '-DparcelableModel=true'. Enable gzip request encoding using '-DuseGzipFeature=true'.
                                                                                retrofit
                                                                                HTTP client: OkHttp 2.x. JSON processing: Gson 2.x (Retrofit 1.9.0). IMPORTANT NOTE: retrofit1.x is no longer actively maintained so please upgrade to 'retrofit2' instead.
                                                                                retrofit2
                                                                                HTTP client: OkHttp 3.x. JSON processing: Gson 2.x (Retrofit 2.3.0). Enable the RxJava adapter using '-DuseRxJava[2]=true'. (RxJava 1.x or 2.x)
                                                                                resttemplate
                                                                                HTTP client: Spring RestTemplate 4.x. JSON processing: Jackson 2.9.x
                                                                                webclient
                                                                                HTTP client: Spring WebClient 5.x. JSON processing: Jackson 2.9.x
                                                                                resteasy
                                                                                HTTP client: Resteasy client 3.x. JSON processing: Jackson 2.9.x
                                                                                vertx
                                                                                HTTP client: VertX client 3.x. JSON processing: Jackson 2.9.x
                                                                                google-api-client
                                                                                HTTP client: Google API client 1.x. JSON processing: Jackson 2.9.x
                                                                                rest-assured
                                                                                HTTP client: rest-assured : 4.x. JSON processing: Gson 2.x or Jackson 2.9.x. Only for Java8
                                                                                native
                                                                                HTTP client: Java native HttpClient. JSON processing: Jackson 2.9.x. Only for Java11+
                                                                                microprofile
                                                                                HTTP client: Microprofile client X.x. JSON processing: Jackson 2.9.x
                                                                                		okhttp-gson
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.client.model
                                                                                parcelableModelWhether to generate models for Android that implement Parcelable with the okhttp-gson library.false
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                performBeanValidationPerform BeanValidationfalse
                                                                                playVersionVersion of Play! Framework (possible values "play24", "play25" (default), "play26")null
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serializationLibrarySerialization library, default depends from the library
                                                                                jackson
                                                                                Use Jackson as serialization library
                                                                                gson
                                                                                Use Gson as serialization library
                                                                                		null
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                supportJava6Whether to support Java6 with the Jersey1 library.false
                                                                                useBeanValidationUse BeanValidation API annotationsfalse
                                                                                useGzipFeatureSend gzip-encoded requestsfalse
                                                                                usePlayWSUse Play! Async HTTP client (Play WS API)false
                                                                                useReflectionEqualsHashCodeUse org.apache.commons.lang3.builder for equals and hashCode in the models. WARNING: This will fail under a security manager, unless the appropriate permissions are set up correctly and also there's potential performance impact.false
                                                                                useRuntimeExceptionUse RuntimeException instead of Exceptionfalse
                                                                                useRxJavaWhether to use the RxJava adapter with the retrofit2 library.false
                                                                                useRxJava2Whether to use the RxJava2 adapter with the retrofit2 library.false
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by William Cheng
                                                                                - + - + - + diff --git a/docs/generators/javascript-closure-angular/index.html b/docs/generators/javascript-closure-angular/index.html index 31f74aab5f2..07a24f71d8a 100644 --- a/docs/generators/javascript-closure-angular/index.html +++ b/docs/generators/javascript-closure-angular/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for javascript-closure-angular

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                useEs6use ES6 templatesfalse

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArray

                                                                                LANGUAGE PRIMITIVES

                                                                                • Blob
                                                                                • Date
                                                                                • Object
                                                                                • boolean
                                                                                • number
                                                                                • string

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • assert
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • new
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✗ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for javascript-closure-angular

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                useEs6use ES6 templatesfalse

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArray

                                                                                LANGUAGE PRIMITIVES

                                                                                • Blob
                                                                                • Date
                                                                                • Object
                                                                                • boolean
                                                                                • number
                                                                                • string

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • assert
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • new
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✗ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/javascript-flowtyped/index.html b/docs/generators/javascript-flowtyped/index.html index 369633870a2..0b3f082442f 100644 --- a/docs/generators/javascript-flowtyped/index.html +++ b/docs/generators/javascript-flowtyped/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for javascript-flowtyped

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                supportsES6Generate code that conforms to ES6.false

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArray
                                                                                listArray
                                                                                mapObject

                                                                                LANGUAGE PRIMITIVES

                                                                                • Array
                                                                                • Blob
                                                                                • Date
                                                                                • File
                                                                                • Object
                                                                                • boolean
                                                                                • number
                                                                                • string

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • arguments
                                                                                • array
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • const
                                                                                • continue
                                                                                • date
                                                                                • debugger
                                                                                • default
                                                                                • delete
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • eval
                                                                                • export
                                                                                • extends
                                                                                • false
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • formparams
                                                                                • function
                                                                                • goto
                                                                                • hasownproperty
                                                                                • headerparams
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • in
                                                                                • infinity
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • isfinite
                                                                                • isnan
                                                                                • isprototypeof
                                                                                • let
                                                                                • long
                                                                                • math
                                                                                • nan
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • number
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • prototype
                                                                                • public
                                                                                • queryparameters
                                                                                • requestoptions
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • string
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • tostring
                                                                                • transient
                                                                                • true
                                                                                • try
                                                                                • typeof
                                                                                • undefined
                                                                                • useformdata
                                                                                • valueof
                                                                                • var
                                                                                • varlocaldeferred
                                                                                • varlocalpath
                                                                                • void
                                                                                • volatile
                                                                                • while
                                                                                • with
                                                                                • yield

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for javascript-flowtyped

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                supportsES6Generate code that conforms to ES6.false

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArray
                                                                                listArray
                                                                                mapObject

                                                                                LANGUAGE PRIMITIVES

                                                                                • Array
                                                                                • Blob
                                                                                • Date
                                                                                • File
                                                                                • Object
                                                                                • boolean
                                                                                • number
                                                                                • string

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • arguments
                                                                                • array
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • const
                                                                                • continue
                                                                                • date
                                                                                • debugger
                                                                                • default
                                                                                • delete
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • eval
                                                                                • export
                                                                                • extends
                                                                                • false
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • formparams
                                                                                • function
                                                                                • goto
                                                                                • hasownproperty
                                                                                • headerparams
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • in
                                                                                • infinity
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • isfinite
                                                                                • isnan
                                                                                • isprototypeof
                                                                                • let
                                                                                • long
                                                                                • math
                                                                                • nan
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • number
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • prototype
                                                                                • public
                                                                                • queryparameters
                                                                                • requestoptions
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • string
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • tostring
                                                                                • transient
                                                                                • true
                                                                                • try
                                                                                • typeof
                                                                                • undefined
                                                                                • useformdata
                                                                                • valueof
                                                                                • var
                                                                                • varlocaldeferred
                                                                                • varlocalpath
                                                                                • void
                                                                                • volatile
                                                                                • while
                                                                                • with
                                                                                • yield

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/javascript/index.html b/docs/generators/javascript/index.html index b3d030ffc5d..15d9bd3b895 100644 --- a/docs/generators/javascript/index.html +++ b/docs/generators/javascript/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for javascript

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesnull
                                                                                emitJSDocgenerate JSDoc commentstrue
                                                                                emitModelMethodsgenerate getters and setters for model propertiesfalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                invokerPackageroot package for generated codenull
                                                                                licenseNamename of the license the project uses (Default: using info.license.name)null
                                                                                modelPackagepackage for generated modelsnull
                                                                                modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                moduleNamemodule name for AMD, Node or globals (Default: generated from <projectName>)null
                                                                                npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                                                                                projectNamename of the project (Default: generated from info.title or "openapi-js-client")null
                                                                                projectVersionversion of the project (Default: using info.version or "1.0.0")null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc
                                                                                useES6use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.true
                                                                                useInheritanceuse JavaScript prototype chains & delegation for inheritancetrue
                                                                                usePromisesuse Promises as return values from the client API, instead of superagent callbacksfalse

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArray
                                                                                listArray
                                                                                mapObject

                                                                                LANGUAGE PRIMITIVES

                                                                                • Array
                                                                                • Blob
                                                                                • Boolean
                                                                                • Date
                                                                                • File
                                                                                • Number
                                                                                • Object
                                                                                • String

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • arguments
                                                                                • array
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • const
                                                                                • continue
                                                                                • date
                                                                                • debugger
                                                                                • default
                                                                                • delete
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • eval
                                                                                • export
                                                                                • extends
                                                                                • false
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • function
                                                                                • goto
                                                                                • hasownproperty
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • in
                                                                                • infinity
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • isfinite
                                                                                • isnan
                                                                                • isprototypeof
                                                                                • let
                                                                                • long
                                                                                • math
                                                                                • nan
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • number
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • prototype
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • string
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • tostring
                                                                                • transient
                                                                                • true
                                                                                • try
                                                                                • typeof
                                                                                • undefined
                                                                                • valueof
                                                                                • var
                                                                                • void
                                                                                • volatile
                                                                                • while
                                                                                • with
                                                                                • yield

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for javascript

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesnull
                                                                                emitJSDocgenerate JSDoc commentstrue
                                                                                emitModelMethodsgenerate getters and setters for model propertiesfalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                invokerPackageroot package for generated codenull
                                                                                licenseNamename of the license the project uses (Default: using info.license.name)null
                                                                                modelPackagepackage for generated modelsnull
                                                                                modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                moduleNamemodule name for AMD, Node or globals (Default: generated from <projectName>)null
                                                                                npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                projectDescriptiondescription of the project (Default: using info.description or "Client library of <projectName>")null
                                                                                projectNamename of the project (Default: generated from info.title or "openapi-js-client")null
                                                                                projectVersionversion of the project (Default: using info.version or "1.0.0")null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc
                                                                                useES6use JavaScript ES6 (ECMAScript 6) (beta). Default is ES6.true
                                                                                useInheritanceuse JavaScript prototype chains & delegation for inheritancetrue
                                                                                usePromisesuse Promises as return values from the client API, instead of superagent callbacksfalse

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArray
                                                                                listArray
                                                                                mapObject

                                                                                LANGUAGE PRIMITIVES

                                                                                • Array
                                                                                • Blob
                                                                                • Boolean
                                                                                • Date
                                                                                • File
                                                                                • Number
                                                                                • Object
                                                                                • String

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • arguments
                                                                                • array
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • const
                                                                                • continue
                                                                                • date
                                                                                • debugger
                                                                                • default
                                                                                • delete
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • eval
                                                                                • export
                                                                                • extends
                                                                                • false
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • function
                                                                                • goto
                                                                                • hasownproperty
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • in
                                                                                • infinity
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • isfinite
                                                                                • isnan
                                                                                • isprototypeof
                                                                                • let
                                                                                • long
                                                                                • math
                                                                                • nan
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • number
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • prototype
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • string
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • tostring
                                                                                • transient
                                                                                • true
                                                                                • try
                                                                                • typeof
                                                                                • undefined
                                                                                • valueof
                                                                                • var
                                                                                • void
                                                                                • volatile
                                                                                • while
                                                                                • with
                                                                                • yield

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✗ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✓OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✓OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✓OAS2,OAS3
                                                                                ApiKey✓OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✓OAS3
                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-cxf-cdi/index.html b/docs/generators/jaxrs-cxf-cdi/index.html index e16f83a080b..3ac2a17e774 100644 --- a/docs/generators/jaxrs-cxf-cdi/index.html +++ b/docs/generators/jaxrs-cxf-cdi/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-cxf-cdi

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-cxf-cdi-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generatePomWhether to generate pom.xml if the file does not already exist.true
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                <default>
                                                                                JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
                                                                                quarkus
                                                                                Server using Quarkus
                                                                                thorntail
                                                                                Server using Thorntail
                                                                                openliberty
                                                                                Server using Open Liberty
                                                                                helidon
                                                                                Server using Helidon
                                                                                		<default>
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                openApiSpecFileLocationLocation where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.null
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/gen/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useSwaggerAnnotationsWhether to generate Swagger annotations.true
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-cxf-cdi

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-cxf-cdi-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generatePomWhether to generate pom.xml if the file does not already exist.true
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                <default>
                                                                                JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
                                                                                quarkus
                                                                                Server using Quarkus
                                                                                thorntail
                                                                                Server using Thorntail
                                                                                openliberty
                                                                                Server using Open Liberty
                                                                                helidon
                                                                                Server using Helidon
                                                                                		<default>
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                openApiSpecFileLocationLocation where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.null
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/gen/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useSwaggerAnnotationsWhether to generate Swagger annotations.true
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-cxf-client/index.html b/docs/generators/jaxrs-cxf-client/index.html index 7ae806ca6c7..906bff40bea 100644 --- a/docs/generators/jaxrs-cxf-client/index.html +++ b/docs/generators/jaxrs-cxf-client/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-cxf-client

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-client
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/gen/java
                                                                                useBeanValidationUse BeanValidation API annotationsfalse
                                                                                useGenericResponseUse generic responsefalse
                                                                                useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                                                                useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-cxf-client

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-client
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/gen/java
                                                                                useBeanValidationUse BeanValidation API annotationsfalse
                                                                                useGenericResponseUse generic responsefalse
                                                                                useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                                                                useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-cxf-extended/index.html b/docs/generators/jaxrs-cxf-extended/index.html index 2d518989850..f9eb3dfcdc4 100644 --- a/docs/generators/jaxrs-cxf-extended/index.html +++ b/docs/generators/jaxrs-cxf-extended/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-cxf-extended

                                                                                OptionDescriptionValuesDefault
                                                                                addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-cxf-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                                                                generateNonSpringApplicationGenerate non-Spring applicationfalse
                                                                                generateOperationBodyGenerate fully functional operation bodiesfalse
                                                                                generateSpringApplicationGenerate Spring applicationfalse
                                                                                generateSpringBootApplicationGenerate Spring Boot applicationfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                loadTestDataFromFileLoad test data from a generated JSON filefalse
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                supportMultipleSpringServicesSupport generation of Spring services from multiple specificationsfalse
                                                                                testDataControlFileJSON file to control test data generationnull
                                                                                testDataFileJSON file to contain generated test datanull
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useAnnotatedBasePathUse @Path annotations for basePathfalse
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useBeanValidationFeatureUse BeanValidation Featurefalse
                                                                                useGenericResponseUse generic responsefalse
                                                                                useGzipFeatureUse Gzip Featurefalse
                                                                                useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                                                                useLoggingFeatureUse Logging Featurefalse
                                                                                useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                                                                useMultipartFeatureUse Multipart Featurefalse
                                                                                useSpringAnnotationConfigUse Spring Annotation Configfalse
                                                                                useSwaggerFeatureUse Swagger Featurefalse
                                                                                useSwaggerUIUse Swagger UIfalse
                                                                                useWadlFeatureUse WADL Featurefalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-cxf-extended

                                                                                OptionDescriptionValuesDefault
                                                                                addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-cxf-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                                                                generateNonSpringApplicationGenerate non-Spring applicationfalse
                                                                                generateOperationBodyGenerate fully functional operation bodiesfalse
                                                                                generateSpringApplicationGenerate Spring applicationfalse
                                                                                generateSpringBootApplicationGenerate Spring Boot applicationfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                loadTestDataFromFileLoad test data from a generated JSON filefalse
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                supportMultipleSpringServicesSupport generation of Spring services from multiple specificationsfalse
                                                                                testDataControlFileJSON file to control test data generationnull
                                                                                testDataFileJSON file to contain generated test datanull
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useAnnotatedBasePathUse @Path annotations for basePathfalse
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useBeanValidationFeatureUse BeanValidation Featurefalse
                                                                                useGenericResponseUse generic responsefalse
                                                                                useGzipFeatureUse Gzip Featurefalse
                                                                                useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                                                                useLoggingFeatureUse Logging Featurefalse
                                                                                useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                                                                useMultipartFeatureUse Multipart Featurefalse
                                                                                useSpringAnnotationConfigUse Spring Annotation Configfalse
                                                                                useSwaggerFeatureUse Swagger Featurefalse
                                                                                useSwaggerUIUse Swagger UIfalse
                                                                                useWadlFeatureUse WADL Featurefalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-cxf/index.html b/docs/generators/jaxrs-cxf/index.html index 3bdbd30d5c3..2046e74e1e7 100644 --- a/docs/generators/jaxrs-cxf/index.html +++ b/docs/generators/jaxrs-cxf/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-cxf

                                                                                OptionDescriptionValuesDefault
                                                                                addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-cxf-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                                                                generateNonSpringApplicationGenerate non-Spring applicationfalse
                                                                                generateSpringApplicationGenerate Spring applicationfalse
                                                                                generateSpringBootApplicationGenerate Spring Boot applicationfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useAnnotatedBasePathUse @Path annotations for basePathfalse
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useBeanValidationFeatureUse BeanValidation Featurefalse
                                                                                useGenericResponseUse generic responsefalse
                                                                                useGzipFeatureUse Gzip Featurefalse
                                                                                useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                                                                useLoggingFeatureUse Logging Featurefalse
                                                                                useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                                                                useMultipartFeatureUse Multipart Featurefalse
                                                                                useSpringAnnotationConfigUse Spring Annotation Configfalse
                                                                                useSwaggerFeatureUse Swagger Featurefalse
                                                                                useSwaggerUIUse Swagger UIfalse
                                                                                useWadlFeatureUse WADL Featurefalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-cxf

                                                                                OptionDescriptionValuesDefault
                                                                                addConsumesProducesJsonAdd @Consumes/@Produces Json to API interfacefalse
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-cxf-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                                                                generateNonSpringApplicationGenerate non-Spring applicationfalse
                                                                                generateSpringApplicationGenerate Spring applicationfalse
                                                                                generateSpringBootApplicationGenerate Spring Boot applicationfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useAnnotatedBasePathUse @Path annotations for basePathfalse
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useBeanValidationFeatureUse BeanValidation Featurefalse
                                                                                useGenericResponseUse generic responsefalse
                                                                                useGzipFeatureUse Gzip Featurefalse
                                                                                useGzipFeatureForTestsUse Gzip Feature for testsfalse
                                                                                useLoggingFeatureUse Logging Featurefalse
                                                                                useLoggingFeatureForTestsUse Logging Feature for testsfalse
                                                                                useMultipartFeatureUse Multipart Featurefalse
                                                                                useSpringAnnotationConfigUse Spring Annotation Configfalse
                                                                                useSwaggerFeatureUse Swagger Featurefalse
                                                                                useSwaggerUIUse Swagger UIfalse
                                                                                useWadlFeatureUse WADL Featurefalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-jersey/index.html b/docs/generators/jaxrs-jersey/index.html index 30d26929a25..a6d8366179e 100644 --- a/docs/generators/jaxrs-jersey/index.html +++ b/docs/generators/jaxrs-jersey/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-jersey

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                jersey1
                                                                                Jersey core 1.x
                                                                                jersey2
                                                                                Jersey core 2.x
                                                                                		jersey2
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                supportJava6Whether to support Java6 with the Jersey1/2 library.false
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useTagsuse tags for creating interface and controller classnamesfalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-jersey

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                jersey1
                                                                                Jersey core 1.x
                                                                                jersey2
                                                                                Jersey core 2.x
                                                                                		jersey2
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                supportJava6Whether to support Java6 with the Jersey1/2 library.false
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useTagsuse tags for creating interface and controller classnamesfalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-resteasy-eap/index.html b/docs/generators/jaxrs-resteasy-eap/index.html index d6b2f5a572a..155e580c5ae 100644 --- a/docs/generators/jaxrs-resteasy-eap/index.html +++ b/docs/generators/jaxrs-resteasy-eap/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-resteasy-eap

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-resteasy-eap-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptortrue
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useSwaggerFeatureUse dynamic Swagger generatorfalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-resteasy-eap

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-resteasy-eap-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptortrue
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useSwaggerFeatureUse dynamic Swagger generatorfalse
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-resteasy/index.html b/docs/generators/jaxrs-resteasy/index.html index 32693fef3b9..8c33e8caa59 100644 --- a/docs/generators/jaxrs-resteasy/index.html +++ b/docs/generators/jaxrs-resteasy/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-resteasy

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-resteasy-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-resteasy

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-resteasy-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generateJbossDeploymentDescriptorGenerate Jboss Deployment Descriptorfalse
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jaxrs-spec/index.html b/docs/generators/jaxrs-spec/index.html index 34e5e6f109a..53d887791fb 100644 --- a/docs/generators/jaxrs-spec/index.html +++ b/docs/generators/jaxrs-spec/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jaxrs-spec

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generatePomWhether to generate pom.xml if the file does not already exist.true
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                <default>
                                                                                JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
                                                                                quarkus
                                                                                Server using Quarkus
                                                                                thorntail
                                                                                Server using Thorntail
                                                                                openliberty
                                                                                Server using Open Liberty
                                                                                helidon
                                                                                Server using Helidon
                                                                                		<default>
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                openApiSpecFileLocationLocation where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.null
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useSwaggerAnnotationsWhether to generate Swagger annotations.true
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                +

                                                                                Config Options for jaxrs-spec

                                                                                OptionDescriptionValuesDefault
                                                                                additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                apiPackagepackage for generated api classesorg.openapitools.api
                                                                                artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-jaxrs-server
                                                                                artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                booleanGetterPrefixSet booleanGetterPrefixget
                                                                                dateLibraryOption. 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)
                                                                                		legacy
                                                                                developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                generatePomWhether to generate pom.xml if the file does not already exist.true
                                                                                groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                implFolderfolder for generated implementation codesrc/main/java
                                                                                interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                invokerPackageroot package for generated codeorg.openapitools.api
                                                                                java8Option. Use Java8 classes instead of third party equivalents
                                                                                true
                                                                                Use Java 8 classes such as Base64
                                                                                false
                                                                                Various third party libraries as needed
                                                                                		false
                                                                                librarylibrary template (sub-template)
                                                                                <default>
                                                                                JAXRS spec only, to be deployed in an app server (TomEE, JBoss, WLS, ...)
                                                                                quarkus
                                                                                Server using Quarkus
                                                                                thorntail
                                                                                Server using Thorntail
                                                                                openliberty
                                                                                Server using Open Liberty
                                                                                helidon
                                                                                Server using Helidon
                                                                                		<default>
                                                                                licenseNameThe name of the licenseUnlicense
                                                                                licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                modelPackagepackage for generated modelsorg.openapitools.model
                                                                                openApiSpecFileLocationLocation where the file containing the spec will be generated in the output folder. No file generated when set to null or empty string.null
                                                                                parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                returnResponseWhether generate API interface should return javax.ws.rs.core.Response instead of a deserialized entity. Only useful if interfaceOnly is true.false
                                                                                scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                serverPortThe port on which the server should be started8080
                                                                                snapshotVersionUses a SNAPSHOT version.
                                                                                true
                                                                                Use a SnapShot Version
                                                                                false
                                                                                Use a Release Version
                                                                                		null
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                sourceFoldersource folder for generated codesrc/main/java
                                                                                titlea title describing the applicationOpenAPI Server
                                                                                useBeanValidationUse BeanValidation API annotationstrue
                                                                                useSwaggerAnnotationsWhether to generate Swagger annotations.true
                                                                                withXmlwhether 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

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.LocalDate
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By
                                                                                arrayArrayList
                                                                                mapHashMap

                                                                                LANGUAGE PRIMITIVES

                                                                                • Boolean
                                                                                • Double
                                                                                • Float
                                                                                • Integer
                                                                                • Long
                                                                                • Object
                                                                                • String
                                                                                • boolean
                                                                                • byte[]

                                                                                RESERVED WORDS

                                                                                • abstract
                                                                                • apiclient
                                                                                • apiexception
                                                                                • apiresponse
                                                                                • assert
                                                                                • boolean
                                                                                • break
                                                                                • byte
                                                                                • case
                                                                                • catch
                                                                                • char
                                                                                • class
                                                                                • configuration
                                                                                • const
                                                                                • continue
                                                                                • default
                                                                                • do
                                                                                • double
                                                                                • else
                                                                                • enum
                                                                                • extends
                                                                                • final
                                                                                • finally
                                                                                • float
                                                                                • for
                                                                                • goto
                                                                                • if
                                                                                • implements
                                                                                • import
                                                                                • instanceof
                                                                                • int
                                                                                • interface
                                                                                • localreturntype
                                                                                • localvaraccept
                                                                                • localvaraccepts
                                                                                • localvarauthnames
                                                                                • localvarcollectionqueryparams
                                                                                • localvarcontenttype
                                                                                • localvarcontenttypes
                                                                                • localvarcookieparams
                                                                                • localvarformparams
                                                                                • localvarheaderparams
                                                                                • localvarpath
                                                                                • localvarpostbody
                                                                                • localvarqueryparams
                                                                                • long
                                                                                • native
                                                                                • new
                                                                                • null
                                                                                • object
                                                                                • package
                                                                                • private
                                                                                • protected
                                                                                • public
                                                                                • return
                                                                                • short
                                                                                • static
                                                                                • strictfp
                                                                                • stringutil
                                                                                • super
                                                                                • switch
                                                                                • synchronized
                                                                                • this
                                                                                • throw
                                                                                • throws
                                                                                • transient
                                                                                • try
                                                                                • void
                                                                                • volatile
                                                                                • while

                                                                                FEATURE SET

                                                                                Client Modification Feature

                                                                                NameSupportedDefined By
                                                                                BasePath✓ToolingExtension
                                                                                Authorizations✗ToolingExtension
                                                                                UserAgent✗ToolingExtension

                                                                                Data Type Feature

                                                                                NameSupportedDefined By
                                                                                Custom✗OAS2,OAS3
                                                                                Int32✓OAS2,OAS3
                                                                                Int64✓OAS2,OAS3
                                                                                Float✓OAS2,OAS3
                                                                                Double✓OAS2,OAS3
                                                                                Decimal✓ToolingExtension
                                                                                String✓OAS2,OAS3
                                                                                Byte✓OAS2,OAS3
                                                                                Binary✓OAS2,OAS3
                                                                                Boolean✓OAS2,OAS3
                                                                                Date✓OAS2,OAS3
                                                                                DateTime✓OAS2,OAS3
                                                                                Password✓OAS2,OAS3
                                                                                File✓OAS2
                                                                                Array✓OAS2,OAS3
                                                                                Maps✓ToolingExtension
                                                                                CollectionFormat✓OAS2
                                                                                CollectionFormatMulti✓OAS2
                                                                                Enum✓OAS2,OAS3
                                                                                ArrayOfEnum✓ToolingExtension
                                                                                ArrayOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                MapOfEnum✓ToolingExtension
                                                                                MapOfModel✓ToolingExtension
                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                Documentation Feature

                                                                                NameSupportedDefined By
                                                                                Readme✓ToolingExtension
                                                                                Model✓ToolingExtension
                                                                                Api✓ToolingExtension

                                                                                Global Feature

                                                                                NameSupportedDefined By
                                                                                Host✓OAS2,OAS3
                                                                                BasePath✓OAS2,OAS3
                                                                                Info✓OAS2,OAS3
                                                                                Schemes✗OAS2,OAS3
                                                                                PartialSchemes✓OAS2,OAS3
                                                                                Consumes✓OAS2
                                                                                Produces✓OAS2
                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                Examples✓OAS2,OAS3
                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                MultiServer✗OAS3
                                                                                ParameterizedServer✗OAS3
                                                                                ParameterStyling✗OAS3
                                                                                Callbacks✗OAS3
                                                                                LinkObjects✗OAS3

                                                                                Parameter Feature

                                                                                NameSupportedDefined By
                                                                                Path✓OAS2,OAS3
                                                                                Query✓OAS2,OAS3
                                                                                Header✓OAS2,OAS3
                                                                                Body✓OAS2
                                                                                FormUnencoded✓OAS2
                                                                                FormMultipart✓OAS2
                                                                                Cookie✓OAS3

                                                                                Schema Support Feature

                                                                                NameSupportedDefined By
                                                                                Simple✓OAS2,OAS3
                                                                                Composite✓OAS2,OAS3
                                                                                Polymorphism✗OAS2,OAS3
                                                                                Union✗OAS3

                                                                                Security Feature

                                                                                NameSupportedDefined By
                                                                                BasicAuth✗OAS2,OAS3
                                                                                ApiKey✗OAS2,OAS3
                                                                                OpenIDConnect✗OAS3
                                                                                BearerToken✗OAS3
                                                                                OAuth2_Implicit✗OAS2,OAS3
                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                Wire Format Feature

                                                                                NameSupportedDefined By
                                                                                JSON✓OAS2,OAS3
                                                                                XML✓OAS2,OAS3
                                                                                PROTOBUF✗ToolingExtension
                                                                                Custom✗OAS2,OAS3
                                                                                Edit this page
                                                                                Last updated on by Jim Schubert
                                                                                - + - + - + diff --git a/docs/generators/jmeter/index.html b/docs/generators/jmeter/index.html index 81606bb35ee..7e1aba93846 100644 --- a/docs/generators/jmeter/index.html +++ b/docs/generators/jmeter/index.html @@ -21,26 +21,26 @@ - +
                                                                                -

                                                                                Config Options for jmeter

                                                                                OptionDescriptionValuesDefault
                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                IMPORT MAPPING

                                                                                Type/AliasImports
                                                                                Arrayjava.util.List
                                                                                ArrayListjava.util.ArrayList
                                                                                BigDecimaljava.math.BigDecimal
                                                                                Datejava.util.Date
                                                                                DateTimeorg.joda.time.*
                                                                                Filejava.io.File
                                                                                HashMapjava.util.HashMap
                                                                                Listjava.util.*
                                                                                LocalDateorg.joda.time.*
                                                                                LocalDateTimeorg.joda.time.*
                                                                                LocalTimeorg.joda.time.*
                                                                                Mapjava.util.Map
                                                                                Setjava.util.*
                                                                                Timestampjava.sql.Timestamp
                                                                                URIjava.net.URI
                                                                                UUIDjava.util.UUID

                                                                                INSTANTIATION TYPES

                                                                                Type/AliasInstantiated By

                                                                                LANGUAGE PRIMITIVES

                                                                                  RESERVED WORDS

                                                                                  • sample1
                                                                                  • sample2

                                                                                  FEATURE SET

                                                                                  Client Modification Feature

                                                                                  NameSupportedDefined By
                                                                                  BasePath✓ToolingExtension
                                                                                  Authorizations✗ToolingExtension
                                                                                  UserAgent✗ToolingExtension

                                                                                  Data Type Feature

                                                                                  NameSupportedDefined By
                                                                                  Custom✗OAS2,OAS3
                                                                                  Int32✓OAS2,OAS3
                                                                                  Int64✓OAS2,OAS3
                                                                                  Float✓OAS2,OAS3
                                                                                  Double✓OAS2,OAS3
                                                                                  Decimal✓ToolingExtension
                                                                                  String✓OAS2,OAS3
                                                                                  Byte✓OAS2,OAS3
                                                                                  Binary✓OAS2,OAS3
                                                                                  Boolean✓OAS2,OAS3
                                                                                  Date✓OAS2,OAS3
                                                                                  DateTime✓OAS2,OAS3
                                                                                  Password✓OAS2,OAS3
                                                                                  File✓OAS2
                                                                                  Array✓OAS2,OAS3
                                                                                  Maps✓ToolingExtension
                                                                                  CollectionFormat✓OAS2
                                                                                  CollectionFormatMulti✓OAS2
                                                                                  Enum✓OAS2,OAS3
                                                                                  ArrayOfEnum✓ToolingExtension
                                                                                  ArrayOfModel✓ToolingExtension
                                                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                  MapOfEnum✓ToolingExtension
                                                                                  MapOfModel✓ToolingExtension
                                                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                  MapOfCollectionOfModel✓ToolingExtension
                                                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                                                  Documentation Feature

                                                                                  NameSupportedDefined By
                                                                                  Readme✗ToolingExtension
                                                                                  Model✓ToolingExtension
                                                                                  Api✓ToolingExtension

                                                                                  Global Feature

                                                                                  NameSupportedDefined By
                                                                                  Host✓OAS2,OAS3
                                                                                  BasePath✓OAS2,OAS3
                                                                                  Info✓OAS2,OAS3
                                                                                  Schemes✗OAS2,OAS3
                                                                                  PartialSchemes✓OAS2,OAS3
                                                                                  Consumes✓OAS2
                                                                                  Produces✓OAS2
                                                                                  ExternalDocumentation✓OAS2,OAS3
                                                                                  Examples✓OAS2,OAS3
                                                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                                                  MultiServer✗OAS3
                                                                                  ParameterizedServer✗OAS3
                                                                                  ParameterStyling✗OAS3
                                                                                  Callbacks✗OAS3
                                                                                  LinkObjects✗OAS3

                                                                                  Parameter Feature

                                                                                  NameSupportedDefined By
                                                                                  Path✓OAS2,OAS3
                                                                                  Query✓OAS2,OAS3
                                                                                  Header✓OAS2,OAS3
                                                                                  Body✓OAS2
                                                                                  FormUnencoded✓OAS2
                                                                                  FormMultipart✓OAS2
                                                                                  Cookie✓OAS3

                                                                                  Schema Support Feature

                                                                                  NameSupportedDefined By
                                                                                  Simple✓OAS2,OAS3
                                                                                  Composite✓OAS2,OAS3
                                                                                  Polymorphism✗OAS2,OAS3
                                                                                  Union✗OAS3

                                                                                  Security Feature

                                                                                  NameSupportedDefined By
                                                                                  BasicAuth✓OAS2,OAS3
                                                                                  ApiKey✓OAS2,OAS3
                                                                                  OpenIDConnect✗OAS3
                                                                                  BearerToken✗OAS3
                                                                                  OAuth2_Implicit✓OAS2,OAS3
                                                                                  OAuth2_Password✗OAS2,OAS3
                                                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                  OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                  Wire Format Feature

                                                                                  NameSupportedDefined By
                                                                                  JSON✓OAS2,OAS3
                                                                                  XML✓OAS2,OAS3
                                                                                  PROTOBUF✗ToolingExtension
                                                                                  Custom✗OAS2,OAS3
                                                                                  Edit this page
                                                                                  Last updated on by Jim Schubert
                                                                                  +

                                                                                  Config Options for jmeter

                                                                                  OptionDescriptionValuesDefault
                                                                                  allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                  ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                  prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                  IMPORT MAPPING

                                                                                  Type/AliasImports
                                                                                  Arrayjava.util.List
                                                                                  ArrayListjava.util.ArrayList
                                                                                  BigDecimaljava.math.BigDecimal
                                                                                  Datejava.util.Date
                                                                                  DateTimeorg.joda.time.*
                                                                                  Filejava.io.File
                                                                                  HashMapjava.util.HashMap
                                                                                  Listjava.util.*
                                                                                  LocalDateorg.joda.time.*
                                                                                  LocalDateTimeorg.joda.time.*
                                                                                  LocalTimeorg.joda.time.*
                                                                                  Mapjava.util.Map
                                                                                  Setjava.util.*
                                                                                  Timestampjava.sql.Timestamp
                                                                                  URIjava.net.URI
                                                                                  UUIDjava.util.UUID

                                                                                  INSTANTIATION TYPES

                                                                                  Type/AliasInstantiated By

                                                                                  LANGUAGE PRIMITIVES

                                                                                    RESERVED WORDS

                                                                                    • sample1
                                                                                    • sample2

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✓ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✗ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    - + - + - + diff --git a/docs/generators/kotlin-server/index.html b/docs/generators/kotlin-server/index.html index a7d3382b4da..10ab4165a37 100644 --- a/docs/generators/kotlin-server/index.html +++ b/docs/generators/kotlin-server/index.html @@ -21,26 +21,26 @@ - +
                                                                                    -

                                                                                    Config Options for kotlin-server

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).kotlin-server
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    featureAutoHeadAutomatically provide responses to HEAD requests for existing routes that have the GET verb defined.true
                                                                                    featureCORSKtor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.false
                                                                                    featureCompressionAdds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.true
                                                                                    featureConditionalHeadersAvoid sending content if client already has same content, by checking ETag or LastModified properties.false
                                                                                    featureHSTSAvoid sending content if client already has same content, by checking ETag or LastModified properties.true
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    librarylibrary template (sub-template)
                                                                                    ktor
                                                                                    ktor framework
                                                                                    		ktor
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    packageNameGenerated artifact package name.org.openapitools.server
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimejava.time.LocalDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✗OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    +

                                                                                    Config Options for kotlin-server

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).kotlin-server
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    featureAutoHeadAutomatically provide responses to HEAD requests for existing routes that have the GET verb defined.true
                                                                                    featureCORSKtor by default provides an interceptor for implementing proper support for Cross-Origin Resource Sharing (CORS). See enable-cors.org.false
                                                                                    featureCompressionAdds ability to compress outgoing content using gzip, deflate or custom encoder and thus reduce size of the response.true
                                                                                    featureConditionalHeadersAvoid sending content if client already has same content, by checking ETag or LastModified properties.false
                                                                                    featureHSTSAvoid sending content if client already has same content, by checking ETag or LastModified properties.true
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    librarylibrary template (sub-template)
                                                                                    ktor
                                                                                    ktor framework
                                                                                    		ktor
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    packageNameGenerated artifact package name.org.openapitools.server
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimejava.time.LocalDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✗OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    - + - + - + diff --git a/docs/generators/kotlin-spring/index.html b/docs/generators/kotlin-spring/index.html index 43a438b00be..fb0fb80d49a 100644 --- a/docs/generators/kotlin-spring/index.html +++ b/docs/generators/kotlin-spring/index.html @@ -21,26 +21,26 @@ - +
                                                                                    -

                                                                                    Config Options for kotlin-spring

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiPackageapi package for generated codeorg.openapitools.api
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).openapi-spring
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                                                                    delegatePatternWhether to generate the server files using the delegate patternfalse
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    exceptionHandlergenerate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )true
                                                                                    gradleBuildFilegenerate a gradle build file using the Kotlin DSLtrue
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                    librarylibrary template (sub-template)
                                                                                    spring-boot
                                                                                    Spring-boot Server application.
                                                                                    		spring-boot
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    modelPackagemodel package for generated codeorg.openapitools.model
                                                                                    packageNameGenerated artifact package name.org.openapitools
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    reactiveuse coroutines for reactive behaviorfalse
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    serverPortconfiguration the port in which the sever is to run on8080
                                                                                    serviceImplementationgenerate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generatedfalse
                                                                                    serviceInterfacegenerate 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 patternfalse
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin
                                                                                    swaggerAnnotationsgenerate swagger annotations to go alongside controllers and modelsfalse
                                                                                    titleserver title name or client service nameOpenAPI Kotlin Spring
                                                                                    useBeanValidationUse BeanValidation API annotations to validate data typestrue

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.time.LocalDate
                                                                                    DateTimejava.time.OffsetDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • ApiClient
                                                                                    • ApiException
                                                                                    • ApiResponse
                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✓OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    +

                                                                                    Config Options for kotlin-spring

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiPackageapi package for generated codeorg.openapitools.api
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).openapi-spring
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                                                                    delegatePatternWhether to generate the server files using the delegate patternfalse
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    exceptionHandlergenerate default global exception handlers (not compatible with reactive. enabling reactive will disable exceptionHandler )true
                                                                                    gradleBuildFilegenerate a gradle build file using the Kotlin DSLtrue
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                    librarylibrary template (sub-template)
                                                                                    spring-boot
                                                                                    Spring-boot Server application.
                                                                                    		spring-boot
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    modelPackagemodel package for generated codeorg.openapitools.model
                                                                                    packageNameGenerated artifact package name.org.openapitools
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    reactiveuse coroutines for reactive behaviorfalse
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    serverPortconfiguration the port in which the sever is to run on8080
                                                                                    serviceImplementationgenerate stub service implementations that extends service interfaces. If this is set to true service interfaces will also be generatedfalse
                                                                                    serviceInterfacegenerate 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 patternfalse
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin
                                                                                    swaggerAnnotationsgenerate swagger annotations to go alongside controllers and modelsfalse
                                                                                    titleserver title name or client service nameOpenAPI Kotlin Spring
                                                                                    useBeanValidationUse BeanValidation API annotations to validate data typestrue

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.time.LocalDate
                                                                                    DateTimejava.time.OffsetDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • ApiClient
                                                                                    • ApiException
                                                                                    • ApiResponse
                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✓OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    - + - + - + diff --git a/docs/generators/kotlin-vertx/index.html b/docs/generators/kotlin-vertx/index.html index 183b5a21ddc..a90f7407594 100644 --- a/docs/generators/kotlin-vertx/index.html +++ b/docs/generators/kotlin-vertx/index.html @@ -21,26 +21,26 @@ - +
                                                                                    -

                                                                                    Config Options for kotlin-vertx

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).null
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    packageNameGenerated artifact package name.org.openapitools
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimejava.time.LocalDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✗OAS2,OAS3
                                                                                    ApiKey✗OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    +

                                                                                    Config Options for kotlin-vertx

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).null
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    packageNameGenerated artifact package name.org.openapitools
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimejava.time.LocalDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✗OAS2,OAS3
                                                                                    ApiKey✗OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    - + - + - + diff --git a/docs/generators/kotlin/index.html b/docs/generators/kotlin/index.html index 57d0578d8a8..47e66e31861 100644 --- a/docs/generators/kotlin/index.html +++ b/docs/generators/kotlin/index.html @@ -21,26 +21,26 @@ - +
                                                                                    -

                                                                                    Config Options for kotlin

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).kotlin-client
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    collectionTypeOption. Collection type to use
                                                                                    array
                                                                                    kotlin.Array
                                                                                    list
                                                                                    kotlin.collections.List
                                                                                    		array
                                                                                    dateLibraryOption. Date library to use
                                                                                    threetenbp-localdatetime
                                                                                    Threetenbp - Backport of JSR310 (jvm only, for legacy app only)
                                                                                    string
                                                                                    String
                                                                                    java8-localdatetime
                                                                                    Java 8 native JSR310 (jvm only, for legacy app only)
                                                                                    java8
                                                                                    Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)
                                                                                    threetenbp
                                                                                    Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)
                                                                                    		java8
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    libraryLibrary template (sub-template) to use
                                                                                    jvm-okhttp4
                                                                                    [DEFAULT] Platform: Java Virtual Machine. HTTP client: OkHttp 4.2.0 (Android 5.0+ and Java 8+). JSON processing: Moshi 1.8.0.
                                                                                    jvm-okhttp3
                                                                                    Platform: Java Virtual Machine. HTTP client: OkHttp 3.12.4 (Android 2.3+ and Java 7+). JSON processing: Moshi 1.8.0.
                                                                                    jvm-retrofit2
                                                                                    Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.
                                                                                    multiplatform
                                                                                    Platform: Kotlin multiplatform. HTTP client: Ktor 1.2.4. JSON processing: Kotlinx Serialization: 0.12.0.
                                                                                    		jvm-okhttp4
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    packageNameGenerated artifact package name.org.openapitools.client
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    requestDateConverterJVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter)
                                                                                    toJson
                                                                                    [DEFAULT] Date formater option using a json converter.
                                                                                    toString
                                                                                    Use the 'toString'-method of the date-time object to retrieve the related string representation.
                                                                                    		toJson
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimejava.time.LocalDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✓ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✗OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✓OAS3
                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✗OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    +

                                                                                    Config Options for kotlin

                                                                                    OptionDescriptionValuesDefault
                                                                                    apiSuffixsuffix for api classesApi
                                                                                    artifactIdGenerated artifact id (name of jar).kotlin-client
                                                                                    artifactVersionGenerated artifact's package version.1.0.0
                                                                                    collectionTypeOption. Collection type to use
                                                                                    array
                                                                                    kotlin.Array
                                                                                    list
                                                                                    kotlin.collections.List
                                                                                    		array
                                                                                    dateLibraryOption. Date library to use
                                                                                    threetenbp-localdatetime
                                                                                    Threetenbp - Backport of JSR310 (jvm only, for legacy app only)
                                                                                    string
                                                                                    String
                                                                                    java8-localdatetime
                                                                                    Java 8 native JSR310 (jvm only, for legacy app only)
                                                                                    java8
                                                                                    Java 8 native JSR310 (jvm only, preferred for jdk 1.8+)
                                                                                    threetenbp
                                                                                    Threetenbp - Backport of JSR310 (jvm only, preferred for jdk < 1.8)
                                                                                    		java8
                                                                                    enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'camelCase
                                                                                    groupIdGenerated artifact package's organization (i.e. maven groupId).org.openapitools
                                                                                    libraryLibrary template (sub-template) to use
                                                                                    jvm-okhttp4
                                                                                    [DEFAULT] Platform: Java Virtual Machine. HTTP client: OkHttp 4.2.0 (Android 5.0+ and Java 8+). JSON processing: Moshi 1.8.0.
                                                                                    jvm-okhttp3
                                                                                    Platform: Java Virtual Machine. HTTP client: OkHttp 3.12.4 (Android 2.3+ and Java 7+). JSON processing: Moshi 1.8.0.
                                                                                    jvm-retrofit2
                                                                                    Platform: Java Virtual Machine. HTTP client: Retrofit 2.6.2.
                                                                                    multiplatform
                                                                                    Platform: Kotlin multiplatform. HTTP client: Ktor 1.2.4. JSON processing: Kotlinx Serialization: 0.12.0.
                                                                                    		jvm-okhttp4
                                                                                    modelMutableCreate mutable modelsfalse
                                                                                    packageNameGenerated artifact package name.org.openapitools.client
                                                                                    parcelizeModelstoggle "@Parcelize" for generated modelsnull
                                                                                    requestDateConverterJVM-Option. Defines in how to handle date-time objects that are used for a request (as query or parameter)
                                                                                    toJson
                                                                                    [DEFAULT] Date formater option using a json converter.
                                                                                    toString
                                                                                    Use the 'toString'-method of the date-time object to retrieve the related string representation.
                                                                                    		toJson
                                                                                    serializableModelboolean - toggle "implements Serializable" for generated modelsnull
                                                                                    serializationLibraryWhat serialization library to use: 'moshi' (default), or 'gson'moshi
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.null
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.null
                                                                                    sourceFoldersource folder for generated codesrc/main/kotlin

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimejava.time.LocalDateTime
                                                                                    Filejava.io.File
                                                                                    LocalDatejava.time.LocalDate
                                                                                    LocalDateTimejava.time.LocalDateTime
                                                                                    LocalTimejava.time.LocalTime
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By
                                                                                    arraykotlin.arrayOf
                                                                                    listkotlin.arrayOf
                                                                                    mapkotlin.mapOf

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • kotlin.Array
                                                                                    • kotlin.Boolean
                                                                                    • kotlin.Byte
                                                                                    • kotlin.ByteArray
                                                                                    • kotlin.Char
                                                                                    • kotlin.Double
                                                                                    • kotlin.Float
                                                                                    • kotlin.Int
                                                                                    • kotlin.Long
                                                                                    • kotlin.Short
                                                                                    • kotlin.String
                                                                                    • kotlin.collections.List
                                                                                    • kotlin.collections.Map
                                                                                    • kotlin.collections.Set

                                                                                    RESERVED WORDS

                                                                                    • as
                                                                                    • break
                                                                                    • class
                                                                                    • continue
                                                                                    • do
                                                                                    • else
                                                                                    • false
                                                                                    • for
                                                                                    • fun
                                                                                    • if
                                                                                    • in
                                                                                    • interface
                                                                                    • is
                                                                                    • null
                                                                                    • object
                                                                                    • package
                                                                                    • return
                                                                                    • super
                                                                                    • this
                                                                                    • throw
                                                                                    • true
                                                                                    • try
                                                                                    • typealias
                                                                                    • typeof
                                                                                    • val
                                                                                    • var
                                                                                    • when
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✓ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✗OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✗OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✓OAS3
                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✗OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    - + - + - + diff --git a/docs/generators/lua/index.html b/docs/generators/lua/index.html index 3383b22806d..7551efc390b 100644 --- a/docs/generators/lua/index.html +++ b/docs/generators/lua/index.html @@ -21,26 +21,26 @@ - +
                                                                                    -

                                                                                    Config Options for lua

                                                                                    OptionDescriptionValuesDefault
                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                    packageNameLua package name (convention: single word).openapiclient
                                                                                    packageVersionLua package version.1.0.0-1

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    *os.Fileos
                                                                                    osio/ioutil
                                                                                    time.Timetime

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • boolean
                                                                                    • nil
                                                                                    • number
                                                                                    • string

                                                                                    RESERVED WORDS

                                                                                    • and
                                                                                    • boolean
                                                                                    • break
                                                                                    • do
                                                                                    • else
                                                                                    • elseif
                                                                                    • end
                                                                                    • false
                                                                                    • for
                                                                                    • function
                                                                                    • if
                                                                                    • in
                                                                                    • local
                                                                                    • nil
                                                                                    • not
                                                                                    • number
                                                                                    • or
                                                                                    • repeat
                                                                                    • return
                                                                                    • string
                                                                                    • table
                                                                                    • then
                                                                                    • thread
                                                                                    • true
                                                                                    • until
                                                                                    • userdata
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✓OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    +

                                                                                    Config Options for lua

                                                                                    OptionDescriptionValuesDefault
                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                    packageNameLua package name (convention: single word).openapiclient
                                                                                    packageVersionLua package version.1.0.0-1

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    *os.Fileos
                                                                                    osio/ioutil
                                                                                    time.Timetime

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By

                                                                                    LANGUAGE PRIMITIVES

                                                                                    • boolean
                                                                                    • nil
                                                                                    • number
                                                                                    • string

                                                                                    RESERVED WORDS

                                                                                    • and
                                                                                    • boolean
                                                                                    • break
                                                                                    • do
                                                                                    • else
                                                                                    • elseif
                                                                                    • end
                                                                                    • false
                                                                                    • for
                                                                                    • function
                                                                                    • if
                                                                                    • in
                                                                                    • local
                                                                                    • nil
                                                                                    • not
                                                                                    • number
                                                                                    • or
                                                                                    • repeat
                                                                                    • return
                                                                                    • string
                                                                                    • table
                                                                                    • then
                                                                                    • thread
                                                                                    • true
                                                                                    • until
                                                                                    • userdata
                                                                                    • while

                                                                                    FEATURE SET

                                                                                    Client Modification Feature

                                                                                    NameSupportedDefined By
                                                                                    BasePath✗ToolingExtension
                                                                                    Authorizations✗ToolingExtension
                                                                                    UserAgent✗ToolingExtension

                                                                                    Data Type Feature

                                                                                    NameSupportedDefined By
                                                                                    Custom✗OAS2,OAS3
                                                                                    Int32✓OAS2,OAS3
                                                                                    Int64✓OAS2,OAS3
                                                                                    Float✓OAS2,OAS3
                                                                                    Double✓OAS2,OAS3
                                                                                    Decimal✓ToolingExtension
                                                                                    String✓OAS2,OAS3
                                                                                    Byte✓OAS2,OAS3
                                                                                    Binary✓OAS2,OAS3
                                                                                    Boolean✓OAS2,OAS3
                                                                                    Date✓OAS2,OAS3
                                                                                    DateTime✓OAS2,OAS3
                                                                                    Password✓OAS2,OAS3
                                                                                    File✓OAS2
                                                                                    Array✓OAS2,OAS3
                                                                                    Maps✓ToolingExtension
                                                                                    CollectionFormat✓OAS2
                                                                                    CollectionFormatMulti✓OAS2
                                                                                    Enum✓OAS2,OAS3
                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                    ArrayOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                    MapOfEnum✓ToolingExtension
                                                                                    MapOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                    Documentation Feature

                                                                                    NameSupportedDefined By
                                                                                    Readme✓ToolingExtension
                                                                                    Model✓ToolingExtension
                                                                                    Api✓ToolingExtension

                                                                                    Global Feature

                                                                                    NameSupportedDefined By
                                                                                    Host✓OAS2,OAS3
                                                                                    BasePath✓OAS2,OAS3
                                                                                    Info✓OAS2,OAS3
                                                                                    Schemes✗OAS2,OAS3
                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                    Consumes✓OAS2
                                                                                    Produces✓OAS2
                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                    Examples✓OAS2,OAS3
                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                    MultiServer✗OAS3
                                                                                    ParameterizedServer✗OAS3
                                                                                    ParameterStyling✗OAS3
                                                                                    Callbacks✗OAS3
                                                                                    LinkObjects✗OAS3

                                                                                    Parameter Feature

                                                                                    NameSupportedDefined By
                                                                                    Path✓OAS2,OAS3
                                                                                    Query✓OAS2,OAS3
                                                                                    Header✓OAS2,OAS3
                                                                                    Body✓OAS2
                                                                                    FormUnencoded✓OAS2
                                                                                    FormMultipart✓OAS2
                                                                                    Cookie✓OAS3

                                                                                    Schema Support Feature

                                                                                    NameSupportedDefined By
                                                                                    Simple✓OAS2,OAS3
                                                                                    Composite✓OAS2,OAS3
                                                                                    Polymorphism✓OAS2,OAS3
                                                                                    Union✗OAS3

                                                                                    Security Feature

                                                                                    NameSupportedDefined By
                                                                                    BasicAuth✓OAS2,OAS3
                                                                                    ApiKey✓OAS2,OAS3
                                                                                    OpenIDConnect✗OAS3
                                                                                    BearerToken✗OAS3
                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                    Wire Format Feature

                                                                                    NameSupportedDefined By
                                                                                    JSON✓OAS2,OAS3
                                                                                    XML✓OAS2,OAS3
                                                                                    PROTOBUF✗ToolingExtension
                                                                                    Custom✗OAS2,OAS3
                                                                                    Edit this page
                                                                                    Last updated on by Jim Schubert
                                                                                    - + - + - + diff --git a/docs/generators/markdown/index.html b/docs/generators/markdown/index.html index c3a6be4f741..8b39d2941d9 100644 --- a/docs/generators/markdown/index.html +++ b/docs/generators/markdown/index.html @@ -21,26 +21,26 @@ - +
                                                                                    -

                                                                                    Config Options for markdown

                                                                                    OptionDescriptionValuesDefault
                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                    IMPORT MAPPING

                                                                                    Type/AliasImports
                                                                                    Arrayjava.util.List
                                                                                    ArrayListjava.util.ArrayList
                                                                                    BigDecimaljava.math.BigDecimal
                                                                                    Datejava.util.Date
                                                                                    DateTimeorg.joda.time.*
                                                                                    Filejava.io.File
                                                                                    HashMapjava.util.HashMap
                                                                                    Listjava.util.*
                                                                                    LocalDateorg.joda.time.*
                                                                                    LocalDateTimeorg.joda.time.*
                                                                                    LocalTimeorg.joda.time.*
                                                                                    Mapjava.util.Map
                                                                                    Setjava.util.*
                                                                                    Timestampjava.sql.Timestamp
                                                                                    URIjava.net.URI
                                                                                    UUIDjava.util.UUID

                                                                                    INSTANTIATION TYPES

                                                                                    Type/AliasInstantiated By

                                                                                    LANGUAGE PRIMITIVES

                                                                                      RESERVED WORDS

                                                                                        FEATURE SET

                                                                                        Client Modification Feature

                                                                                        NameSupportedDefined By
                                                                                        BasePath✗ToolingExtension
                                                                                        Authorizations✗ToolingExtension
                                                                                        UserAgent✗ToolingExtension

                                                                                        Data Type Feature

                                                                                        NameSupportedDefined By
                                                                                        Custom✗OAS2,OAS3
                                                                                        Int32✓OAS2,OAS3
                                                                                        Int64✓OAS2,OAS3
                                                                                        Float✓OAS2,OAS3
                                                                                        Double✓OAS2,OAS3
                                                                                        Decimal✓ToolingExtension
                                                                                        String✓OAS2,OAS3
                                                                                        Byte✓OAS2,OAS3
                                                                                        Binary✓OAS2,OAS3
                                                                                        Boolean✓OAS2,OAS3
                                                                                        Date✓OAS2,OAS3
                                                                                        DateTime✓OAS2,OAS3
                                                                                        Password✓OAS2,OAS3
                                                                                        File✓OAS2
                                                                                        Array✓OAS2,OAS3
                                                                                        Maps✓ToolingExtension
                                                                                        CollectionFormat✓OAS2
                                                                                        CollectionFormatMulti✓OAS2
                                                                                        Enum✓OAS2,OAS3
                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                        ArrayOfModel✓ToolingExtension
                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                        MapOfEnum✓ToolingExtension
                                                                                        MapOfModel✓ToolingExtension
                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                        Documentation Feature

                                                                                        NameSupportedDefined By
                                                                                        Readme✗ToolingExtension
                                                                                        Model✓ToolingExtension
                                                                                        Api✓ToolingExtension

                                                                                        Global Feature

                                                                                        NameSupportedDefined By
                                                                                        Host✓OAS2,OAS3
                                                                                        BasePath✓OAS2,OAS3
                                                                                        Info✓OAS2,OAS3
                                                                                        Schemes✗OAS2,OAS3
                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                        Consumes✓OAS2
                                                                                        Produces✓OAS2
                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                        Examples✓OAS2,OAS3
                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                        MultiServer✗OAS3
                                                                                        ParameterizedServer✗OAS3
                                                                                        ParameterStyling✗OAS3
                                                                                        Callbacks✓OAS3
                                                                                        LinkObjects✗OAS3

                                                                                        Parameter Feature

                                                                                        NameSupportedDefined By
                                                                                        Path✓OAS2,OAS3
                                                                                        Query✓OAS2,OAS3
                                                                                        Header✓OAS2,OAS3
                                                                                        Body✓OAS2
                                                                                        FormUnencoded✓OAS2
                                                                                        FormMultipart✓OAS2
                                                                                        Cookie✓OAS3

                                                                                        Schema Support Feature

                                                                                        NameSupportedDefined By
                                                                                        Simple✓OAS2,OAS3
                                                                                        Composite✓OAS2,OAS3
                                                                                        Polymorphism✓OAS2,OAS3
                                                                                        Union✗OAS3

                                                                                        Security Feature

                                                                                        NameSupportedDefined By
                                                                                        BasicAuth✓OAS2,OAS3
                                                                                        ApiKey✓OAS2,OAS3
                                                                                        OpenIDConnect✗OAS3
                                                                                        BearerToken✓OAS3
                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                        Wire Format Feature

                                                                                        NameSupportedDefined By
                                                                                        JSON✓OAS2,OAS3
                                                                                        XML✓OAS2,OAS3
                                                                                        PROTOBUF✗ToolingExtension
                                                                                        Custom✗OAS2,OAS3
                                                                                        Edit this page
                                                                                        Last updated on by Jim Schubert
                                                                                        +

                                                                                        Config Options for markdown

                                                                                        OptionDescriptionValuesDefault
                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                        IMPORT MAPPING

                                                                                        Type/AliasImports
                                                                                        Arrayjava.util.List
                                                                                        ArrayListjava.util.ArrayList
                                                                                        BigDecimaljava.math.BigDecimal
                                                                                        Datejava.util.Date
                                                                                        DateTimeorg.joda.time.*
                                                                                        Filejava.io.File
                                                                                        HashMapjava.util.HashMap
                                                                                        Listjava.util.*
                                                                                        LocalDateorg.joda.time.*
                                                                                        LocalDateTimeorg.joda.time.*
                                                                                        LocalTimeorg.joda.time.*
                                                                                        Mapjava.util.Map
                                                                                        Setjava.util.*
                                                                                        Timestampjava.sql.Timestamp
                                                                                        URIjava.net.URI
                                                                                        UUIDjava.util.UUID

                                                                                        INSTANTIATION TYPES

                                                                                        Type/AliasInstantiated By

                                                                                        LANGUAGE PRIMITIVES

                                                                                          RESERVED WORDS

                                                                                            FEATURE SET

                                                                                            Client Modification Feature

                                                                                            NameSupportedDefined By
                                                                                            BasePath✗ToolingExtension
                                                                                            Authorizations✗ToolingExtension
                                                                                            UserAgent✗ToolingExtension

                                                                                            Data Type Feature

                                                                                            NameSupportedDefined By
                                                                                            Custom✗OAS2,OAS3
                                                                                            Int32✓OAS2,OAS3
                                                                                            Int64✓OAS2,OAS3
                                                                                            Float✓OAS2,OAS3
                                                                                            Double✓OAS2,OAS3
                                                                                            Decimal✓ToolingExtension
                                                                                            String✓OAS2,OAS3
                                                                                            Byte✓OAS2,OAS3
                                                                                            Binary✓OAS2,OAS3
                                                                                            Boolean✓OAS2,OAS3
                                                                                            Date✓OAS2,OAS3
                                                                                            DateTime✓OAS2,OAS3
                                                                                            Password✓OAS2,OAS3
                                                                                            File✓OAS2
                                                                                            Array✓OAS2,OAS3
                                                                                            Maps✓ToolingExtension
                                                                                            CollectionFormat✓OAS2
                                                                                            CollectionFormatMulti✓OAS2
                                                                                            Enum✓OAS2,OAS3
                                                                                            ArrayOfEnum✓ToolingExtension
                                                                                            ArrayOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                            MapOfEnum✓ToolingExtension
                                                                                            MapOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                                            Documentation Feature

                                                                                            NameSupportedDefined By
                                                                                            Readme✗ToolingExtension
                                                                                            Model✓ToolingExtension
                                                                                            Api✓ToolingExtension

                                                                                            Global Feature

                                                                                            NameSupportedDefined By
                                                                                            Host✓OAS2,OAS3
                                                                                            BasePath✓OAS2,OAS3
                                                                                            Info✓OAS2,OAS3
                                                                                            Schemes✗OAS2,OAS3
                                                                                            PartialSchemes✓OAS2,OAS3
                                                                                            Consumes✓OAS2
                                                                                            Produces✓OAS2
                                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                                            Examples✓OAS2,OAS3
                                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                                            MultiServer✗OAS3
                                                                                            ParameterizedServer✗OAS3
                                                                                            ParameterStyling✗OAS3
                                                                                            Callbacks✓OAS3
                                                                                            LinkObjects✗OAS3

                                                                                            Parameter Feature

                                                                                            NameSupportedDefined By
                                                                                            Path✓OAS2,OAS3
                                                                                            Query✓OAS2,OAS3
                                                                                            Header✓OAS2,OAS3
                                                                                            Body✓OAS2
                                                                                            FormUnencoded✓OAS2
                                                                                            FormMultipart✓OAS2
                                                                                            Cookie✓OAS3

                                                                                            Schema Support Feature

                                                                                            NameSupportedDefined By
                                                                                            Simple✓OAS2,OAS3
                                                                                            Composite✓OAS2,OAS3
                                                                                            Polymorphism✓OAS2,OAS3
                                                                                            Union✗OAS3

                                                                                            Security Feature

                                                                                            NameSupportedDefined By
                                                                                            BasicAuth✓OAS2,OAS3
                                                                                            ApiKey✓OAS2,OAS3
                                                                                            OpenIDConnect✗OAS3
                                                                                            BearerToken✓OAS3
                                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                                            OAuth2_Password✓OAS2,OAS3
                                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                            Wire Format Feature

                                                                                            NameSupportedDefined By
                                                                                            JSON✓OAS2,OAS3
                                                                                            XML✓OAS2,OAS3
                                                                                            PROTOBUF✗ToolingExtension
                                                                                            Custom✗OAS2,OAS3
                                                                                            Edit this page
                                                                                            Last updated on by Jim Schubert
                                                                                            - + - + - + diff --git a/docs/generators/mysql-schema/index.html b/docs/generators/mysql-schema/index.html index 85bd6cc0e52..8dd72f1fa89 100644 --- a/docs/generators/mysql-schema/index.html +++ b/docs/generators/mysql-schema/index.html @@ -21,26 +21,26 @@ - +
                                                                                            -

                                                                                            Config Options for mysql-schema

                                                                                            OptionDescriptionValuesDefault
                                                                                            defaultDatabaseNameDefault database name for all MySQL queries
                                                                                            identifierNamingConventionNaming convention of MySQL identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option
                                                                                            original
                                                                                            Do not transform original names
                                                                                            snake_case
                                                                                            Use snake_case names
                                                                                            		original
                                                                                            jsonDataTypeEnabledUse special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabledtrue

                                                                                            IMPORT MAPPING

                                                                                            Type/AliasImports

                                                                                            INSTANTIATION TYPES

                                                                                            Type/AliasInstantiated By

                                                                                            LANGUAGE PRIMITIVES

                                                                                            • BigDecimal
                                                                                            • ByteArray
                                                                                            • Date
                                                                                            • DateTime
                                                                                            • URI
                                                                                            • UUID
                                                                                            • binary
                                                                                            • bool
                                                                                            • boolean
                                                                                            • byte
                                                                                            • char
                                                                                            • date
                                                                                            • double
                                                                                            • file
                                                                                            • float
                                                                                            • int
                                                                                            • integer
                                                                                            • long
                                                                                            • mixed
                                                                                            • number
                                                                                            • short
                                                                                            • string
                                                                                            • void

                                                                                            RESERVED WORDS

                                                                                            • accessible
                                                                                            • add
                                                                                            • all
                                                                                            • alter
                                                                                            • analyze
                                                                                            • and
                                                                                            • as
                                                                                            • asc
                                                                                            • asensitive
                                                                                            • before
                                                                                            • between
                                                                                            • bigint
                                                                                            • binary
                                                                                            • blob
                                                                                            • both
                                                                                            • by
                                                                                            • call
                                                                                            • cascade
                                                                                            • case
                                                                                            • change
                                                                                            • char
                                                                                            • character
                                                                                            • check
                                                                                            • collate
                                                                                            • column
                                                                                            • condition
                                                                                            • constraint
                                                                                            • continue
                                                                                            • convert
                                                                                            • create
                                                                                            • cross
                                                                                            • cube
                                                                                            • cume_dist
                                                                                            • current_date
                                                                                            • current_time
                                                                                            • current_timestamp
                                                                                            • current_user
                                                                                            • cursor
                                                                                            • database
                                                                                            • databases
                                                                                            • day_hour
                                                                                            • day_microsecond
                                                                                            • day_minute
                                                                                            • day_second
                                                                                            • dec
                                                                                            • decimal
                                                                                            • declare
                                                                                            • default
                                                                                            • delayed
                                                                                            • delete
                                                                                            • dense_rank
                                                                                            • desc
                                                                                            • describe
                                                                                            • deterministic
                                                                                            • distinct
                                                                                            • distinctrow
                                                                                            • div
                                                                                            • double
                                                                                            • drop
                                                                                            • dual
                                                                                            • each
                                                                                            • else
                                                                                            • elseif
                                                                                            • empty
                                                                                            • enclosed
                                                                                            • escaped
                                                                                            • except
                                                                                            • exists
                                                                                            • exit
                                                                                            • explain
                                                                                            • false
                                                                                            • fetch
                                                                                            • first_value
                                                                                            • float
                                                                                            • float4
                                                                                            • float8
                                                                                            • for
                                                                                            • force
                                                                                            • foreign
                                                                                            • from
                                                                                            • fulltext
                                                                                            • function
                                                                                            • generated
                                                                                            • get
                                                                                            • grant
                                                                                            • group
                                                                                            • grouping
                                                                                            • groups
                                                                                            • having
                                                                                            • high_priority
                                                                                            • hour_microsecond
                                                                                            • hour_minute
                                                                                            • hour_second
                                                                                            • if
                                                                                            • ignore
                                                                                            • in
                                                                                            • index
                                                                                            • infile
                                                                                            • inner
                                                                                            • inout
                                                                                            • insensitive
                                                                                            • insert
                                                                                            • int
                                                                                            • int1
                                                                                            • int2
                                                                                            • int3
                                                                                            • int4
                                                                                            • int8
                                                                                            • integer
                                                                                            • interval
                                                                                            • into
                                                                                            • io_after_gtids
                                                                                            • io_before_gtids
                                                                                            • is
                                                                                            • iterate
                                                                                            • join
                                                                                            • json_table
                                                                                            • key
                                                                                            • keys
                                                                                            • kill
                                                                                            • lag
                                                                                            • last_value
                                                                                            • lead
                                                                                            • leading
                                                                                            • leave
                                                                                            • left
                                                                                            • like
                                                                                            • limit
                                                                                            • linear
                                                                                            • lines
                                                                                            • load
                                                                                            • localtime
                                                                                            • localtimestamp
                                                                                            • lock
                                                                                            • long
                                                                                            • longblob
                                                                                            • longtext
                                                                                            • loop
                                                                                            • low_priority
                                                                                            • master_bind
                                                                                            • master_ssl_verify_server_cert
                                                                                            • match
                                                                                            • maxvalue
                                                                                            • mediumblob
                                                                                            • mediumint
                                                                                            • mediumtext
                                                                                            • middleint
                                                                                            • minute_microsecond
                                                                                            • minute_second
                                                                                            • mod
                                                                                            • modifies
                                                                                            • natural
                                                                                            • no_write_to_binlog
                                                                                            • not
                                                                                            • nth_value
                                                                                            • ntile
                                                                                            • null
                                                                                            • numeric
                                                                                            • of
                                                                                            • on
                                                                                            • optimize
                                                                                            • optimizer_costs
                                                                                            • option
                                                                                            • optionally
                                                                                            • or
                                                                                            • order
                                                                                            • out
                                                                                            • outer
                                                                                            • outfile
                                                                                            • over
                                                                                            • partition
                                                                                            • percent_rank
                                                                                            • persist
                                                                                            • persist_only
                                                                                            • precision
                                                                                            • primary
                                                                                            • procedure
                                                                                            • purge
                                                                                            • range
                                                                                            • rank
                                                                                            • read
                                                                                            • read_write
                                                                                            • reads
                                                                                            • real
                                                                                            • recursive
                                                                                            • references
                                                                                            • regexp
                                                                                            • release
                                                                                            • rename
                                                                                            • repeat
                                                                                            • replace
                                                                                            • require
                                                                                            • resignal
                                                                                            • restrict
                                                                                            • return
                                                                                            • revoke
                                                                                            • right
                                                                                            • rlike
                                                                                            • role
                                                                                            • row
                                                                                            • row_number
                                                                                            • rows
                                                                                            • schema
                                                                                            • schemas
                                                                                            • second_microsecond
                                                                                            • select
                                                                                            • sensitive
                                                                                            • separator
                                                                                            • set
                                                                                            • show
                                                                                            • signal
                                                                                            • smallint
                                                                                            • spatial
                                                                                            • specific
                                                                                            • sql
                                                                                            • sql_big_result
                                                                                            • sql_calc_found_rows
                                                                                            • sql_small_result
                                                                                            • sqlexception
                                                                                            • sqlstate
                                                                                            • sqlwarning
                                                                                            • ssl
                                                                                            • starting
                                                                                            • stored
                                                                                            • straight_join
                                                                                            • system
                                                                                            • table
                                                                                            • terminated
                                                                                            • then
                                                                                            • tinyblob
                                                                                            • tinyint
                                                                                            • tinytext
                                                                                            • to
                                                                                            • trailing
                                                                                            • trigger
                                                                                            • true
                                                                                            • undo
                                                                                            • union
                                                                                            • unique
                                                                                            • unlock
                                                                                            • unsigned
                                                                                            • update
                                                                                            • usage
                                                                                            • use
                                                                                            • using
                                                                                            • utc_date
                                                                                            • utc_time
                                                                                            • utc_timestamp
                                                                                            • values
                                                                                            • varbinary
                                                                                            • varchar
                                                                                            • varcharacter
                                                                                            • varying
                                                                                            • virtual
                                                                                            • when
                                                                                            • where
                                                                                            • while
                                                                                            • window
                                                                                            • with
                                                                                            • write
                                                                                            • xor
                                                                                            • year_month
                                                                                            • zerofill

                                                                                            FEATURE SET

                                                                                            Client Modification Feature

                                                                                            NameSupportedDefined By
                                                                                            BasePath✗ToolingExtension
                                                                                            Authorizations✗ToolingExtension
                                                                                            UserAgent✗ToolingExtension

                                                                                            Data Type Feature

                                                                                            NameSupportedDefined By
                                                                                            Custom✗OAS2,OAS3
                                                                                            Int32✓OAS2,OAS3
                                                                                            Int64✓OAS2,OAS3
                                                                                            Float✓OAS2,OAS3
                                                                                            Double✓OAS2,OAS3
                                                                                            Decimal✓ToolingExtension
                                                                                            String✓OAS2,OAS3
                                                                                            Byte✓OAS2,OAS3
                                                                                            Binary✓OAS2,OAS3
                                                                                            Boolean✓OAS2,OAS3
                                                                                            Date✓OAS2,OAS3
                                                                                            DateTime✓OAS2,OAS3
                                                                                            Password✓OAS2,OAS3
                                                                                            File✓OAS2
                                                                                            Array✓OAS2,OAS3
                                                                                            Maps✓ToolingExtension
                                                                                            CollectionFormat✓OAS2
                                                                                            CollectionFormatMulti✓OAS2
                                                                                            Enum✓OAS2,OAS3
                                                                                            ArrayOfEnum✓ToolingExtension
                                                                                            ArrayOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                            MapOfEnum✓ToolingExtension
                                                                                            MapOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                                            Documentation Feature

                                                                                            NameSupportedDefined By
                                                                                            Readme✓ToolingExtension
                                                                                            Model✓ToolingExtension
                                                                                            Api✓ToolingExtension

                                                                                            Global Feature

                                                                                            NameSupportedDefined By
                                                                                            Host✓OAS2,OAS3
                                                                                            BasePath✓OAS2,OAS3
                                                                                            Info✓OAS2,OAS3
                                                                                            Schemes✗OAS2,OAS3
                                                                                            PartialSchemes✓OAS2,OAS3
                                                                                            Consumes✓OAS2
                                                                                            Produces✓OAS2
                                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                                            Examples✓OAS2,OAS3
                                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                                            MultiServer✗OAS3
                                                                                            ParameterizedServer✗OAS3
                                                                                            ParameterStyling✗OAS3
                                                                                            Callbacks✗OAS3
                                                                                            LinkObjects✗OAS3

                                                                                            Parameter Feature

                                                                                            NameSupportedDefined By
                                                                                            Path✓OAS2,OAS3
                                                                                            Query✓OAS2,OAS3
                                                                                            Header✓OAS2,OAS3
                                                                                            Body✓OAS2
                                                                                            FormUnencoded✓OAS2
                                                                                            FormMultipart✓OAS2
                                                                                            Cookie✓OAS3

                                                                                            Schema Support Feature

                                                                                            NameSupportedDefined By
                                                                                            Simple✓OAS2,OAS3
                                                                                            Composite✓OAS2,OAS3
                                                                                            Polymorphism✗OAS2,OAS3
                                                                                            Union✗OAS3

                                                                                            Security Feature

                                                                                            NameSupportedDefined By
                                                                                            BasicAuth✗OAS2,OAS3
                                                                                            ApiKey✗OAS2,OAS3
                                                                                            OpenIDConnect✗OAS3
                                                                                            BearerToken✗OAS3
                                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                                            OAuth2_Password✗OAS2,OAS3
                                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                            Wire Format Feature

                                                                                            NameSupportedDefined By
                                                                                            JSON✗OAS2,OAS3
                                                                                            XML✗OAS2,OAS3
                                                                                            PROTOBUF✗ToolingExtension
                                                                                            Custom✗OAS2,OAS3
                                                                                            Edit this page
                                                                                            Last updated on by Jim Schubert
                                                                                            +

                                                                                            Config Options for mysql-schema

                                                                                            OptionDescriptionValuesDefault
                                                                                            defaultDatabaseNameDefault database name for all MySQL queries
                                                                                            identifierNamingConventionNaming convention of MySQL identifiers(table names and column names). This is not related to database name which is defined by defaultDatabaseName option
                                                                                            original
                                                                                            Do not transform original names
                                                                                            snake_case
                                                                                            Use snake_case names
                                                                                            		original
                                                                                            jsonDataTypeEnabledUse special JSON MySQL data type for complex model properties. Requires MySQL version 5.7.8. Generates TEXT data type when disabledtrue

                                                                                            IMPORT MAPPING

                                                                                            Type/AliasImports

                                                                                            INSTANTIATION TYPES

                                                                                            Type/AliasInstantiated By

                                                                                            LANGUAGE PRIMITIVES

                                                                                            • BigDecimal
                                                                                            • ByteArray
                                                                                            • Date
                                                                                            • DateTime
                                                                                            • URI
                                                                                            • UUID
                                                                                            • binary
                                                                                            • bool
                                                                                            • boolean
                                                                                            • byte
                                                                                            • char
                                                                                            • date
                                                                                            • double
                                                                                            • file
                                                                                            • float
                                                                                            • int
                                                                                            • integer
                                                                                            • long
                                                                                            • mixed
                                                                                            • number
                                                                                            • short
                                                                                            • string
                                                                                            • void

                                                                                            RESERVED WORDS

                                                                                            • accessible
                                                                                            • add
                                                                                            • all
                                                                                            • alter
                                                                                            • analyze
                                                                                            • and
                                                                                            • as
                                                                                            • asc
                                                                                            • asensitive
                                                                                            • before
                                                                                            • between
                                                                                            • bigint
                                                                                            • binary
                                                                                            • blob
                                                                                            • both
                                                                                            • by
                                                                                            • call
                                                                                            • cascade
                                                                                            • case
                                                                                            • change
                                                                                            • char
                                                                                            • character
                                                                                            • check
                                                                                            • collate
                                                                                            • column
                                                                                            • condition
                                                                                            • constraint
                                                                                            • continue
                                                                                            • convert
                                                                                            • create
                                                                                            • cross
                                                                                            • cube
                                                                                            • cume_dist
                                                                                            • current_date
                                                                                            • current_time
                                                                                            • current_timestamp
                                                                                            • current_user
                                                                                            • cursor
                                                                                            • database
                                                                                            • databases
                                                                                            • day_hour
                                                                                            • day_microsecond
                                                                                            • day_minute
                                                                                            • day_second
                                                                                            • dec
                                                                                            • decimal
                                                                                            • declare
                                                                                            • default
                                                                                            • delayed
                                                                                            • delete
                                                                                            • dense_rank
                                                                                            • desc
                                                                                            • describe
                                                                                            • deterministic
                                                                                            • distinct
                                                                                            • distinctrow
                                                                                            • div
                                                                                            • double
                                                                                            • drop
                                                                                            • dual
                                                                                            • each
                                                                                            • else
                                                                                            • elseif
                                                                                            • empty
                                                                                            • enclosed
                                                                                            • escaped
                                                                                            • except
                                                                                            • exists
                                                                                            • exit
                                                                                            • explain
                                                                                            • false
                                                                                            • fetch
                                                                                            • first_value
                                                                                            • float
                                                                                            • float4
                                                                                            • float8
                                                                                            • for
                                                                                            • force
                                                                                            • foreign
                                                                                            • from
                                                                                            • fulltext
                                                                                            • function
                                                                                            • generated
                                                                                            • get
                                                                                            • grant
                                                                                            • group
                                                                                            • grouping
                                                                                            • groups
                                                                                            • having
                                                                                            • high_priority
                                                                                            • hour_microsecond
                                                                                            • hour_minute
                                                                                            • hour_second
                                                                                            • if
                                                                                            • ignore
                                                                                            • in
                                                                                            • index
                                                                                            • infile
                                                                                            • inner
                                                                                            • inout
                                                                                            • insensitive
                                                                                            • insert
                                                                                            • int
                                                                                            • int1
                                                                                            • int2
                                                                                            • int3
                                                                                            • int4
                                                                                            • int8
                                                                                            • integer
                                                                                            • interval
                                                                                            • into
                                                                                            • io_after_gtids
                                                                                            • io_before_gtids
                                                                                            • is
                                                                                            • iterate
                                                                                            • join
                                                                                            • json_table
                                                                                            • key
                                                                                            • keys
                                                                                            • kill
                                                                                            • lag
                                                                                            • last_value
                                                                                            • lead
                                                                                            • leading
                                                                                            • leave
                                                                                            • left
                                                                                            • like
                                                                                            • limit
                                                                                            • linear
                                                                                            • lines
                                                                                            • load
                                                                                            • localtime
                                                                                            • localtimestamp
                                                                                            • lock
                                                                                            • long
                                                                                            • longblob
                                                                                            • longtext
                                                                                            • loop
                                                                                            • low_priority
                                                                                            • master_bind
                                                                                            • master_ssl_verify_server_cert
                                                                                            • match
                                                                                            • maxvalue
                                                                                            • mediumblob
                                                                                            • mediumint
                                                                                            • mediumtext
                                                                                            • middleint
                                                                                            • minute_microsecond
                                                                                            • minute_second
                                                                                            • mod
                                                                                            • modifies
                                                                                            • natural
                                                                                            • no_write_to_binlog
                                                                                            • not
                                                                                            • nth_value
                                                                                            • ntile
                                                                                            • null
                                                                                            • numeric
                                                                                            • of
                                                                                            • on
                                                                                            • optimize
                                                                                            • optimizer_costs
                                                                                            • option
                                                                                            • optionally
                                                                                            • or
                                                                                            • order
                                                                                            • out
                                                                                            • outer
                                                                                            • outfile
                                                                                            • over
                                                                                            • partition
                                                                                            • percent_rank
                                                                                            • persist
                                                                                            • persist_only
                                                                                            • precision
                                                                                            • primary
                                                                                            • procedure
                                                                                            • purge
                                                                                            • range
                                                                                            • rank
                                                                                            • read
                                                                                            • read_write
                                                                                            • reads
                                                                                            • real
                                                                                            • recursive
                                                                                            • references
                                                                                            • regexp
                                                                                            • release
                                                                                            • rename
                                                                                            • repeat
                                                                                            • replace
                                                                                            • require
                                                                                            • resignal
                                                                                            • restrict
                                                                                            • return
                                                                                            • revoke
                                                                                            • right
                                                                                            • rlike
                                                                                            • role
                                                                                            • row
                                                                                            • row_number
                                                                                            • rows
                                                                                            • schema
                                                                                            • schemas
                                                                                            • second_microsecond
                                                                                            • select
                                                                                            • sensitive
                                                                                            • separator
                                                                                            • set
                                                                                            • show
                                                                                            • signal
                                                                                            • smallint
                                                                                            • spatial
                                                                                            • specific
                                                                                            • sql
                                                                                            • sql_big_result
                                                                                            • sql_calc_found_rows
                                                                                            • sql_small_result
                                                                                            • sqlexception
                                                                                            • sqlstate
                                                                                            • sqlwarning
                                                                                            • ssl
                                                                                            • starting
                                                                                            • stored
                                                                                            • straight_join
                                                                                            • system
                                                                                            • table
                                                                                            • terminated
                                                                                            • then
                                                                                            • tinyblob
                                                                                            • tinyint
                                                                                            • tinytext
                                                                                            • to
                                                                                            • trailing
                                                                                            • trigger
                                                                                            • true
                                                                                            • undo
                                                                                            • union
                                                                                            • unique
                                                                                            • unlock
                                                                                            • unsigned
                                                                                            • update
                                                                                            • usage
                                                                                            • use
                                                                                            • using
                                                                                            • utc_date
                                                                                            • utc_time
                                                                                            • utc_timestamp
                                                                                            • values
                                                                                            • varbinary
                                                                                            • varchar
                                                                                            • varcharacter
                                                                                            • varying
                                                                                            • virtual
                                                                                            • when
                                                                                            • where
                                                                                            • while
                                                                                            • window
                                                                                            • with
                                                                                            • write
                                                                                            • xor
                                                                                            • year_month
                                                                                            • zerofill

                                                                                            FEATURE SET

                                                                                            Client Modification Feature

                                                                                            NameSupportedDefined By
                                                                                            BasePath✗ToolingExtension
                                                                                            Authorizations✗ToolingExtension
                                                                                            UserAgent✗ToolingExtension

                                                                                            Data Type Feature

                                                                                            NameSupportedDefined By
                                                                                            Custom✗OAS2,OAS3
                                                                                            Int32✓OAS2,OAS3
                                                                                            Int64✓OAS2,OAS3
                                                                                            Float✓OAS2,OAS3
                                                                                            Double✓OAS2,OAS3
                                                                                            Decimal✓ToolingExtension
                                                                                            String✓OAS2,OAS3
                                                                                            Byte✓OAS2,OAS3
                                                                                            Binary✓OAS2,OAS3
                                                                                            Boolean✓OAS2,OAS3
                                                                                            Date✓OAS2,OAS3
                                                                                            DateTime✓OAS2,OAS3
                                                                                            Password✓OAS2,OAS3
                                                                                            File✓OAS2
                                                                                            Array✓OAS2,OAS3
                                                                                            Maps✓ToolingExtension
                                                                                            CollectionFormat✓OAS2
                                                                                            CollectionFormatMulti✓OAS2
                                                                                            Enum✓OAS2,OAS3
                                                                                            ArrayOfEnum✓ToolingExtension
                                                                                            ArrayOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                            MapOfEnum✓ToolingExtension
                                                                                            MapOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                                            Documentation Feature

                                                                                            NameSupportedDefined By
                                                                                            Readme✓ToolingExtension
                                                                                            Model✓ToolingExtension
                                                                                            Api✓ToolingExtension

                                                                                            Global Feature

                                                                                            NameSupportedDefined By
                                                                                            Host✓OAS2,OAS3
                                                                                            BasePath✓OAS2,OAS3
                                                                                            Info✓OAS2,OAS3
                                                                                            Schemes✗OAS2,OAS3
                                                                                            PartialSchemes✓OAS2,OAS3
                                                                                            Consumes✓OAS2
                                                                                            Produces✓OAS2
                                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                                            Examples✓OAS2,OAS3
                                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                                            MultiServer✗OAS3
                                                                                            ParameterizedServer✗OAS3
                                                                                            ParameterStyling✗OAS3
                                                                                            Callbacks✗OAS3
                                                                                            LinkObjects✗OAS3

                                                                                            Parameter Feature

                                                                                            NameSupportedDefined By
                                                                                            Path✓OAS2,OAS3
                                                                                            Query✓OAS2,OAS3
                                                                                            Header✓OAS2,OAS3
                                                                                            Body✓OAS2
                                                                                            FormUnencoded✓OAS2
                                                                                            FormMultipart✓OAS2
                                                                                            Cookie✓OAS3

                                                                                            Schema Support Feature

                                                                                            NameSupportedDefined By
                                                                                            Simple✓OAS2,OAS3
                                                                                            Composite✓OAS2,OAS3
                                                                                            Polymorphism✗OAS2,OAS3
                                                                                            Union✗OAS3

                                                                                            Security Feature

                                                                                            NameSupportedDefined By
                                                                                            BasicAuth✗OAS2,OAS3
                                                                                            ApiKey✗OAS2,OAS3
                                                                                            OpenIDConnect✗OAS3
                                                                                            BearerToken✗OAS3
                                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                                            OAuth2_Password✗OAS2,OAS3
                                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                            Wire Format Feature

                                                                                            NameSupportedDefined By
                                                                                            JSON✗OAS2,OAS3
                                                                                            XML✗OAS2,OAS3
                                                                                            PROTOBUF✗ToolingExtension
                                                                                            Custom✗OAS2,OAS3
                                                                                            Edit this page
                                                                                            Last updated on by Jim Schubert
                                                                                            - + - + - + diff --git a/docs/generators/nim/index.html b/docs/generators/nim/index.html index 5e39170a65c..a28db4f2307 100644 --- a/docs/generators/nim/index.html +++ b/docs/generators/nim/index.html @@ -21,26 +21,26 @@ - +
                                                                                            -

                                                                                            Config Options for nim

                                                                                            OptionDescriptionValuesDefault
                                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                            IMPORT MAPPING

                                                                                            Type/AliasImports
                                                                                            Arrayjava.util.List
                                                                                            ArrayListjava.util.ArrayList
                                                                                            BigDecimaljava.math.BigDecimal
                                                                                            Datejava.util.Date
                                                                                            DateTimeorg.joda.time.*
                                                                                            Filejava.io.File
                                                                                            HashMapjava.util.HashMap
                                                                                            Listjava.util.*
                                                                                            LocalDateorg.joda.time.*
                                                                                            LocalDateTimeorg.joda.time.*
                                                                                            LocalTimeorg.joda.time.*
                                                                                            Mapjava.util.Map
                                                                                            Setjava.util.*
                                                                                            Timestampjava.sql.Timestamp
                                                                                            URIjava.net.URI
                                                                                            UUIDjava.util.UUID

                                                                                            INSTANTIATION TYPES

                                                                                            Type/AliasInstantiated By

                                                                                            LANGUAGE PRIMITIVES

                                                                                            • bool
                                                                                            • char
                                                                                            • cstring
                                                                                            • float
                                                                                            • float32
                                                                                            • float64
                                                                                            • int
                                                                                            • int16
                                                                                            • int32
                                                                                            • int64
                                                                                            • int8
                                                                                            • pointer
                                                                                            • string
                                                                                            • uint
                                                                                            • uint16
                                                                                            • uint32
                                                                                            • uint64
                                                                                            • uint8

                                                                                            RESERVED WORDS

                                                                                            • addr
                                                                                            • and
                                                                                            • as
                                                                                            • asm
                                                                                            • bind
                                                                                            • block
                                                                                            • break
                                                                                            • case
                                                                                            • cast
                                                                                            • concept
                                                                                            • const
                                                                                            • continue
                                                                                            • converter
                                                                                            • defer
                                                                                            • discard
                                                                                            • distinct
                                                                                            • div
                                                                                            • do
                                                                                            • elif
                                                                                            • else
                                                                                            • end
                                                                                            • enum
                                                                                            • except
                                                                                            • export
                                                                                            • finally
                                                                                            • for
                                                                                            • from
                                                                                            • func
                                                                                            • if
                                                                                            • import
                                                                                            • in
                                                                                            • include
                                                                                            • interface
                                                                                            • is
                                                                                            • isnot
                                                                                            • iterator
                                                                                            • let
                                                                                            • macro
                                                                                            • method
                                                                                            • mixin
                                                                                            • mod
                                                                                            • nil
                                                                                            • not
                                                                                            • notin
                                                                                            • object
                                                                                            • of
                                                                                            • or
                                                                                            • out
                                                                                            • proc
                                                                                            • ptr
                                                                                            • raise
                                                                                            • ref
                                                                                            • return
                                                                                            • shl
                                                                                            • shr
                                                                                            • static
                                                                                            • template
                                                                                            • try
                                                                                            • tuple
                                                                                            • type
                                                                                            • using
                                                                                            • var
                                                                                            • when
                                                                                            • while
                                                                                            • xor
                                                                                            • yield

                                                                                            FEATURE SET

                                                                                            Client Modification Feature

                                                                                            NameSupportedDefined By
                                                                                            BasePath✓ToolingExtension
                                                                                            Authorizations✗ToolingExtension
                                                                                            UserAgent✓ToolingExtension

                                                                                            Data Type Feature

                                                                                            NameSupportedDefined By
                                                                                            Custom✗OAS2,OAS3
                                                                                            Int32✓OAS2,OAS3
                                                                                            Int64✓OAS2,OAS3
                                                                                            Float✓OAS2,OAS3
                                                                                            Double✓OAS2,OAS3
                                                                                            Decimal✓ToolingExtension
                                                                                            String✓OAS2,OAS3
                                                                                            Byte✓OAS2,OAS3
                                                                                            Binary✓OAS2,OAS3
                                                                                            Boolean✓OAS2,OAS3
                                                                                            Date✓OAS2,OAS3
                                                                                            DateTime✓OAS2,OAS3
                                                                                            Password✓OAS2,OAS3
                                                                                            File✓OAS2
                                                                                            Array✓OAS2,OAS3
                                                                                            Maps✓ToolingExtension
                                                                                            CollectionFormat✓OAS2
                                                                                            CollectionFormatMulti✓OAS2
                                                                                            Enum✓OAS2,OAS3
                                                                                            ArrayOfEnum✓ToolingExtension
                                                                                            ArrayOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                            MapOfEnum✓ToolingExtension
                                                                                            MapOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                                            Documentation Feature

                                                                                            NameSupportedDefined By
                                                                                            Readme✓ToolingExtension
                                                                                            Model✓ToolingExtension
                                                                                            Api✓ToolingExtension

                                                                                            Global Feature

                                                                                            NameSupportedDefined By
                                                                                            Host✓OAS2,OAS3
                                                                                            BasePath✓OAS2,OAS3
                                                                                            Info✓OAS2,OAS3
                                                                                            Schemes✗OAS2,OAS3
                                                                                            PartialSchemes✓OAS2,OAS3
                                                                                            Consumes✓OAS2
                                                                                            Produces✓OAS2
                                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                                            Examples✓OAS2,OAS3
                                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                                            MultiServer✗OAS3
                                                                                            ParameterizedServer✗OAS3
                                                                                            ParameterStyling✗OAS3
                                                                                            Callbacks✗OAS3
                                                                                            LinkObjects✗OAS3

                                                                                            Parameter Feature

                                                                                            NameSupportedDefined By
                                                                                            Path✓OAS2,OAS3
                                                                                            Query✓OAS2,OAS3
                                                                                            Header✓OAS2,OAS3
                                                                                            Body✓OAS2
                                                                                            FormUnencoded✓OAS2
                                                                                            FormMultipart✓OAS2
                                                                                            Cookie✗OAS3

                                                                                            Schema Support Feature

                                                                                            NameSupportedDefined By
                                                                                            Simple✓OAS2,OAS3
                                                                                            Composite✓OAS2,OAS3
                                                                                            Polymorphism✗OAS2,OAS3
                                                                                            Union✗OAS3

                                                                                            Security Feature

                                                                                            NameSupportedDefined By
                                                                                            BasicAuth✗OAS2,OAS3
                                                                                            ApiKey✗OAS2,OAS3
                                                                                            OpenIDConnect✗OAS3
                                                                                            BearerToken✗OAS3
                                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                                            OAuth2_Password✗OAS2,OAS3
                                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                            Wire Format Feature

                                                                                            NameSupportedDefined By
                                                                                            JSON✓OAS2,OAS3
                                                                                            XML✗OAS2,OAS3
                                                                                            PROTOBUF✗ToolingExtension
                                                                                            Custom✗OAS2,OAS3
                                                                                            Edit this page
                                                                                            Last updated on by Jim Schubert
                                                                                            +

                                                                                            Config Options for nim

                                                                                            OptionDescriptionValuesDefault
                                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                            IMPORT MAPPING

                                                                                            Type/AliasImports
                                                                                            Arrayjava.util.List
                                                                                            ArrayListjava.util.ArrayList
                                                                                            BigDecimaljava.math.BigDecimal
                                                                                            Datejava.util.Date
                                                                                            DateTimeorg.joda.time.*
                                                                                            Filejava.io.File
                                                                                            HashMapjava.util.HashMap
                                                                                            Listjava.util.*
                                                                                            LocalDateorg.joda.time.*
                                                                                            LocalDateTimeorg.joda.time.*
                                                                                            LocalTimeorg.joda.time.*
                                                                                            Mapjava.util.Map
                                                                                            Setjava.util.*
                                                                                            Timestampjava.sql.Timestamp
                                                                                            URIjava.net.URI
                                                                                            UUIDjava.util.UUID

                                                                                            INSTANTIATION TYPES

                                                                                            Type/AliasInstantiated By

                                                                                            LANGUAGE PRIMITIVES

                                                                                            • bool
                                                                                            • char
                                                                                            • cstring
                                                                                            • float
                                                                                            • float32
                                                                                            • float64
                                                                                            • int
                                                                                            • int16
                                                                                            • int32
                                                                                            • int64
                                                                                            • int8
                                                                                            • pointer
                                                                                            • string
                                                                                            • uint
                                                                                            • uint16
                                                                                            • uint32
                                                                                            • uint64
                                                                                            • uint8

                                                                                            RESERVED WORDS

                                                                                            • addr
                                                                                            • and
                                                                                            • as
                                                                                            • asm
                                                                                            • bind
                                                                                            • block
                                                                                            • break
                                                                                            • case
                                                                                            • cast
                                                                                            • concept
                                                                                            • const
                                                                                            • continue
                                                                                            • converter
                                                                                            • defer
                                                                                            • discard
                                                                                            • distinct
                                                                                            • div
                                                                                            • do
                                                                                            • elif
                                                                                            • else
                                                                                            • end
                                                                                            • enum
                                                                                            • except
                                                                                            • export
                                                                                            • finally
                                                                                            • for
                                                                                            • from
                                                                                            • func
                                                                                            • if
                                                                                            • import
                                                                                            • in
                                                                                            • include
                                                                                            • interface
                                                                                            • is
                                                                                            • isnot
                                                                                            • iterator
                                                                                            • let
                                                                                            • macro
                                                                                            • method
                                                                                            • mixin
                                                                                            • mod
                                                                                            • nil
                                                                                            • not
                                                                                            • notin
                                                                                            • object
                                                                                            • of
                                                                                            • or
                                                                                            • out
                                                                                            • proc
                                                                                            • ptr
                                                                                            • raise
                                                                                            • ref
                                                                                            • return
                                                                                            • shl
                                                                                            • shr
                                                                                            • static
                                                                                            • template
                                                                                            • try
                                                                                            • tuple
                                                                                            • type
                                                                                            • using
                                                                                            • var
                                                                                            • when
                                                                                            • while
                                                                                            • xor
                                                                                            • yield

                                                                                            FEATURE SET

                                                                                            Client Modification Feature

                                                                                            NameSupportedDefined By
                                                                                            BasePath✓ToolingExtension
                                                                                            Authorizations✗ToolingExtension
                                                                                            UserAgent✓ToolingExtension

                                                                                            Data Type Feature

                                                                                            NameSupportedDefined By
                                                                                            Custom✗OAS2,OAS3
                                                                                            Int32✓OAS2,OAS3
                                                                                            Int64✓OAS2,OAS3
                                                                                            Float✓OAS2,OAS3
                                                                                            Double✓OAS2,OAS3
                                                                                            Decimal✓ToolingExtension
                                                                                            String✓OAS2,OAS3
                                                                                            Byte✓OAS2,OAS3
                                                                                            Binary✓OAS2,OAS3
                                                                                            Boolean✓OAS2,OAS3
                                                                                            Date✓OAS2,OAS3
                                                                                            DateTime✓OAS2,OAS3
                                                                                            Password✓OAS2,OAS3
                                                                                            File✓OAS2
                                                                                            Array✓OAS2,OAS3
                                                                                            Maps✓ToolingExtension
                                                                                            CollectionFormat✓OAS2
                                                                                            CollectionFormatMulti✓OAS2
                                                                                            Enum✓OAS2,OAS3
                                                                                            ArrayOfEnum✓ToolingExtension
                                                                                            ArrayOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                            MapOfEnum✓ToolingExtension
                                                                                            MapOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                                            Documentation Feature

                                                                                            NameSupportedDefined By
                                                                                            Readme✓ToolingExtension
                                                                                            Model✓ToolingExtension
                                                                                            Api✓ToolingExtension

                                                                                            Global Feature

                                                                                            NameSupportedDefined By
                                                                                            Host✓OAS2,OAS3
                                                                                            BasePath✓OAS2,OAS3
                                                                                            Info✓OAS2,OAS3
                                                                                            Schemes✗OAS2,OAS3
                                                                                            PartialSchemes✓OAS2,OAS3
                                                                                            Consumes✓OAS2
                                                                                            Produces✓OAS2
                                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                                            Examples✓OAS2,OAS3
                                                                                            XMLStructureDefinitions✗OAS2,OAS3
                                                                                            MultiServer✗OAS3
                                                                                            ParameterizedServer✗OAS3
                                                                                            ParameterStyling✗OAS3
                                                                                            Callbacks✗OAS3
                                                                                            LinkObjects✗OAS3

                                                                                            Parameter Feature

                                                                                            NameSupportedDefined By
                                                                                            Path✓OAS2,OAS3
                                                                                            Query✓OAS2,OAS3
                                                                                            Header✓OAS2,OAS3
                                                                                            Body✓OAS2
                                                                                            FormUnencoded✓OAS2
                                                                                            FormMultipart✓OAS2
                                                                                            Cookie✗OAS3

                                                                                            Schema Support Feature

                                                                                            NameSupportedDefined By
                                                                                            Simple✓OAS2,OAS3
                                                                                            Composite✓OAS2,OAS3
                                                                                            Polymorphism✗OAS2,OAS3
                                                                                            Union✗OAS3

                                                                                            Security Feature

                                                                                            NameSupportedDefined By
                                                                                            BasicAuth✗OAS2,OAS3
                                                                                            ApiKey✗OAS2,OAS3
                                                                                            OpenIDConnect✗OAS3
                                                                                            BearerToken✗OAS3
                                                                                            OAuth2_Implicit✗OAS2,OAS3
                                                                                            OAuth2_Password✗OAS2,OAS3
                                                                                            OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                            OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                            Wire Format Feature

                                                                                            NameSupportedDefined By
                                                                                            JSON✓OAS2,OAS3
                                                                                            XML✗OAS2,OAS3
                                                                                            PROTOBUF✗ToolingExtension
                                                                                            Custom✗OAS2,OAS3
                                                                                            Edit this page
                                                                                            Last updated on by Jim Schubert
                                                                                            - + - + - + diff --git a/docs/generators/nodejs-express-server/index.html b/docs/generators/nodejs-express-server/index.html index 80591b4b3a0..c4f662ce277 100644 --- a/docs/generators/nodejs-express-server/index.html +++ b/docs/generators/nodejs-express-server/index.html @@ -21,26 +21,26 @@ - +
                                                                                            -

                                                                                            Config Options for nodejs-express-server

                                                                                            OptionDescriptionValuesDefault
                                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                            serverPortTCP port to listen on.null
                                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                            IMPORT MAPPING

                                                                                            Type/AliasImports
                                                                                            Arrayjava.util.List
                                                                                            ArrayListjava.util.ArrayList
                                                                                            BigDecimaljava.math.BigDecimal
                                                                                            Datejava.util.Date
                                                                                            DateTimeorg.joda.time.*
                                                                                            Filejava.io.File
                                                                                            HashMapjava.util.HashMap
                                                                                            Listjava.util.*
                                                                                            LocalDateorg.joda.time.*
                                                                                            LocalDateTimeorg.joda.time.*
                                                                                            LocalTimeorg.joda.time.*
                                                                                            Mapjava.util.Map
                                                                                            Setjava.util.*
                                                                                            Timestampjava.sql.Timestamp
                                                                                            URIjava.net.URI
                                                                                            UUIDjava.util.UUID

                                                                                            INSTANTIATION TYPES

                                                                                            Type/AliasInstantiated By

                                                                                            LANGUAGE PRIMITIVES

                                                                                              RESERVED WORDS

                                                                                              • break
                                                                                              • case
                                                                                              • catch
                                                                                              • class
                                                                                              • const
                                                                                              • continue
                                                                                              • debugger
                                                                                              • default
                                                                                              • delete
                                                                                              • do
                                                                                              • else
                                                                                              • export
                                                                                              • extends
                                                                                              • finally
                                                                                              • for
                                                                                              • function
                                                                                              • if
                                                                                              • import
                                                                                              • in
                                                                                              • instanceof
                                                                                              • let
                                                                                              • new
                                                                                              • return
                                                                                              • super
                                                                                              • switch
                                                                                              • this
                                                                                              • throw
                                                                                              • try
                                                                                              • typeof
                                                                                              • var
                                                                                              • void
                                                                                              • while
                                                                                              • with
                                                                                              • yield

                                                                                              FEATURE SET

                                                                                              Client Modification Feature

                                                                                              NameSupportedDefined By
                                                                                              BasePath✗ToolingExtension
                                                                                              Authorizations✗ToolingExtension
                                                                                              UserAgent✗ToolingExtension

                                                                                              Data Type Feature

                                                                                              NameSupportedDefined By
                                                                                              Custom✗OAS2,OAS3
                                                                                              Int32✓OAS2,OAS3
                                                                                              Int64✓OAS2,OAS3
                                                                                              Float✓OAS2,OAS3
                                                                                              Double✓OAS2,OAS3
                                                                                              Decimal✓ToolingExtension
                                                                                              String✓OAS2,OAS3
                                                                                              Byte✓OAS2,OAS3
                                                                                              Binary✓OAS2,OAS3
                                                                                              Boolean✓OAS2,OAS3
                                                                                              Date✓OAS2,OAS3
                                                                                              DateTime✓OAS2,OAS3
                                                                                              Password✓OAS2,OAS3
                                                                                              File✓OAS2
                                                                                              Array✓OAS2,OAS3
                                                                                              Maps✓ToolingExtension
                                                                                              CollectionFormat✓OAS2
                                                                                              CollectionFormatMulti✓OAS2
                                                                                              Enum✓OAS2,OAS3
                                                                                              ArrayOfEnum✓ToolingExtension
                                                                                              ArrayOfModel✓ToolingExtension
                                                                                              ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                              ArrayOfCollectionOfModel✓ToolingExtension
                                                                                              ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                              MapOfEnum✓ToolingExtension
                                                                                              MapOfModel✓ToolingExtension
                                                                                              MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                              MapOfCollectionOfModel✓ToolingExtension
                                                                                              MapOfCollectionOfEnum✓ToolingExtension

                                                                                              Documentation Feature

                                                                                              NameSupportedDefined By
                                                                                              Readme✓ToolingExtension
                                                                                              Model✓ToolingExtension
                                                                                              Api✓ToolingExtension

                                                                                              Global Feature

                                                                                              NameSupportedDefined By
                                                                                              Host✓OAS2,OAS3
                                                                                              BasePath✓OAS2,OAS3
                                                                                              Info✓OAS2,OAS3
                                                                                              Schemes✗OAS2,OAS3
                                                                                              PartialSchemes✓OAS2,OAS3
                                                                                              Consumes✓OAS2
                                                                                              Produces✓OAS2
                                                                                              ExternalDocumentation✓OAS2,OAS3
                                                                                              Examples✓OAS2,OAS3
                                                                                              XMLStructureDefinitions✗OAS2,OAS3
                                                                                              MultiServer✗OAS3
                                                                                              ParameterizedServer✗OAS3
                                                                                              ParameterStyling✗OAS3
                                                                                              Callbacks✗OAS3
                                                                                              LinkObjects✗OAS3

                                                                                              Parameter Feature

                                                                                              NameSupportedDefined By
                                                                                              Path✓OAS2,OAS3
                                                                                              Query✓OAS2,OAS3
                                                                                              Header✓OAS2,OAS3
                                                                                              Body✓OAS2
                                                                                              FormUnencoded✓OAS2
                                                                                              FormMultipart✓OAS2
                                                                                              Cookie✓OAS3

                                                                                              Schema Support Feature

                                                                                              NameSupportedDefined By
                                                                                              Simple✓OAS2,OAS3
                                                                                              Composite✓OAS2,OAS3
                                                                                              Polymorphism✗OAS2,OAS3
                                                                                              Union✗OAS3

                                                                                              Security Feature

                                                                                              NameSupportedDefined By
                                                                                              BasicAuth✗OAS2,OAS3
                                                                                              ApiKey✗OAS2,OAS3
                                                                                              OpenIDConnect✗OAS3
                                                                                              BearerToken✗OAS3
                                                                                              OAuth2_Implicit✓OAS2,OAS3
                                                                                              OAuth2_Password✗OAS2,OAS3
                                                                                              OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                              OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                              Wire Format Feature

                                                                                              NameSupportedDefined By
                                                                                              JSON✓OAS2,OAS3
                                                                                              XML✗OAS2,OAS3
                                                                                              PROTOBUF✗ToolingExtension
                                                                                              Custom✗OAS2,OAS3
                                                                                              Edit this page
                                                                                              Last updated on by Jim Schubert
                                                                                              +

                                                                                              Config Options for nodejs-express-server

                                                                                              OptionDescriptionValuesDefault
                                                                                              allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                              ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                              prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                              serverPortTCP port to listen on.null
                                                                                              sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                              sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                              IMPORT MAPPING

                                                                                              Type/AliasImports
                                                                                              Arrayjava.util.List
                                                                                              ArrayListjava.util.ArrayList
                                                                                              BigDecimaljava.math.BigDecimal
                                                                                              Datejava.util.Date
                                                                                              DateTimeorg.joda.time.*
                                                                                              Filejava.io.File
                                                                                              HashMapjava.util.HashMap
                                                                                              Listjava.util.*
                                                                                              LocalDateorg.joda.time.*
                                                                                              LocalDateTimeorg.joda.time.*
                                                                                              LocalTimeorg.joda.time.*
                                                                                              Mapjava.util.Map
                                                                                              Setjava.util.*
                                                                                              Timestampjava.sql.Timestamp
                                                                                              URIjava.net.URI
                                                                                              UUIDjava.util.UUID

                                                                                              INSTANTIATION TYPES

                                                                                              Type/AliasInstantiated By

                                                                                              LANGUAGE PRIMITIVES

                                                                                                RESERVED WORDS

                                                                                                • break
                                                                                                • case
                                                                                                • catch
                                                                                                • class
                                                                                                • const
                                                                                                • continue
                                                                                                • debugger
                                                                                                • default
                                                                                                • delete
                                                                                                • do
                                                                                                • else
                                                                                                • export
                                                                                                • extends
                                                                                                • finally
                                                                                                • for
                                                                                                • function
                                                                                                • if
                                                                                                • import
                                                                                                • in
                                                                                                • instanceof
                                                                                                • let
                                                                                                • new
                                                                                                • return
                                                                                                • super
                                                                                                • switch
                                                                                                • this
                                                                                                • throw
                                                                                                • try
                                                                                                • typeof
                                                                                                • var
                                                                                                • void
                                                                                                • while
                                                                                                • with
                                                                                                • yield

                                                                                                FEATURE SET

                                                                                                Client Modification Feature

                                                                                                NameSupportedDefined By
                                                                                                BasePath✗ToolingExtension
                                                                                                Authorizations✗ToolingExtension
                                                                                                UserAgent✗ToolingExtension

                                                                                                Data Type Feature

                                                                                                NameSupportedDefined By
                                                                                                Custom✗OAS2,OAS3
                                                                                                Int32✓OAS2,OAS3
                                                                                                Int64✓OAS2,OAS3
                                                                                                Float✓OAS2,OAS3
                                                                                                Double✓OAS2,OAS3
                                                                                                Decimal✓ToolingExtension
                                                                                                String✓OAS2,OAS3
                                                                                                Byte✓OAS2,OAS3
                                                                                                Binary✓OAS2,OAS3
                                                                                                Boolean✓OAS2,OAS3
                                                                                                Date✓OAS2,OAS3
                                                                                                DateTime✓OAS2,OAS3
                                                                                                Password✓OAS2,OAS3
                                                                                                File✓OAS2
                                                                                                Array✓OAS2,OAS3
                                                                                                Maps✓ToolingExtension
                                                                                                CollectionFormat✓OAS2
                                                                                                CollectionFormatMulti✓OAS2
                                                                                                Enum✓OAS2,OAS3
                                                                                                ArrayOfEnum✓ToolingExtension
                                                                                                ArrayOfModel✓ToolingExtension
                                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                MapOfEnum✓ToolingExtension
                                                                                                MapOfModel✓ToolingExtension
                                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                                Documentation Feature

                                                                                                NameSupportedDefined By
                                                                                                Readme✓ToolingExtension
                                                                                                Model✓ToolingExtension
                                                                                                Api✓ToolingExtension

                                                                                                Global Feature

                                                                                                NameSupportedDefined By
                                                                                                Host✓OAS2,OAS3
                                                                                                BasePath✓OAS2,OAS3
                                                                                                Info✓OAS2,OAS3
                                                                                                Schemes✗OAS2,OAS3
                                                                                                PartialSchemes✓OAS2,OAS3
                                                                                                Consumes✓OAS2
                                                                                                Produces✓OAS2
                                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                                Examples✓OAS2,OAS3
                                                                                                XMLStructureDefinitions✗OAS2,OAS3
                                                                                                MultiServer✗OAS3
                                                                                                ParameterizedServer✗OAS3
                                                                                                ParameterStyling✗OAS3
                                                                                                Callbacks✗OAS3
                                                                                                LinkObjects✗OAS3

                                                                                                Parameter Feature

                                                                                                NameSupportedDefined By
                                                                                                Path✓OAS2,OAS3
                                                                                                Query✓OAS2,OAS3
                                                                                                Header✓OAS2,OAS3
                                                                                                Body✓OAS2
                                                                                                FormUnencoded✓OAS2
                                                                                                FormMultipart✓OAS2
                                                                                                Cookie✓OAS3

                                                                                                Schema Support Feature

                                                                                                NameSupportedDefined By
                                                                                                Simple✓OAS2,OAS3
                                                                                                Composite✓OAS2,OAS3
                                                                                                Polymorphism✗OAS2,OAS3
                                                                                                Union✗OAS3

                                                                                                Security Feature

                                                                                                NameSupportedDefined By
                                                                                                BasicAuth✗OAS2,OAS3
                                                                                                ApiKey✗OAS2,OAS3
                                                                                                OpenIDConnect✗OAS3
                                                                                                BearerToken✗OAS3
                                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                                OAuth2_Password✗OAS2,OAS3
                                                                                                OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                Wire Format Feature

                                                                                                NameSupportedDefined By
                                                                                                JSON✓OAS2,OAS3
                                                                                                XML✗OAS2,OAS3
                                                                                                PROTOBUF✗ToolingExtension
                                                                                                Custom✗OAS2,OAS3
                                                                                                Edit this page
                                                                                                Last updated on by Jim Schubert
                                                                                                - + - + - + diff --git a/docs/generators/nodejs-server-deprecated/index.html b/docs/generators/nodejs-server-deprecated/index.html index ad433b36576..22f9ce17e55 100644 --- a/docs/generators/nodejs-server-deprecated/index.html +++ b/docs/generators/nodejs-server-deprecated/index.html @@ -21,26 +21,26 @@ - +
                                                                                                -

                                                                                                Config Options for nodejs-server-deprecated

                                                                                                OptionDescriptionValuesDefault
                                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                exportedNameWhen 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
                                                                                                googleCloudFunctionsWhen 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
                                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                serverPortTCP port to listen on.null
                                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                IMPORT MAPPING

                                                                                                Type/AliasImports
                                                                                                Arrayjava.util.List
                                                                                                ArrayListjava.util.ArrayList
                                                                                                BigDecimaljava.math.BigDecimal
                                                                                                Datejava.util.Date
                                                                                                DateTimeorg.joda.time.*
                                                                                                Filejava.io.File
                                                                                                HashMapjava.util.HashMap
                                                                                                Listjava.util.*
                                                                                                LocalDateorg.joda.time.*
                                                                                                LocalDateTimeorg.joda.time.*
                                                                                                LocalTimeorg.joda.time.*
                                                                                                Mapjava.util.Map
                                                                                                Setjava.util.*
                                                                                                Timestampjava.sql.Timestamp
                                                                                                URIjava.net.URI
                                                                                                UUIDjava.util.UUID

                                                                                                INSTANTIATION TYPES

                                                                                                Type/AliasInstantiated By

                                                                                                LANGUAGE PRIMITIVES

                                                                                                  RESERVED WORDS

                                                                                                  • break
                                                                                                  • case
                                                                                                  • catch
                                                                                                  • class
                                                                                                  • const
                                                                                                  • continue
                                                                                                  • debugger
                                                                                                  • default
                                                                                                  • delete
                                                                                                  • do
                                                                                                  • else
                                                                                                  • export
                                                                                                  • extends
                                                                                                  • finally
                                                                                                  • for
                                                                                                  • function
                                                                                                  • if
                                                                                                  • import
                                                                                                  • in
                                                                                                  • instanceof
                                                                                                  • let
                                                                                                  • new
                                                                                                  • return
                                                                                                  • super
                                                                                                  • switch
                                                                                                  • this
                                                                                                  • throw
                                                                                                  • try
                                                                                                  • typeof
                                                                                                  • var
                                                                                                  • void
                                                                                                  • while
                                                                                                  • with
                                                                                                  • yield

                                                                                                  FEATURE SET

                                                                                                  Client Modification Feature

                                                                                                  NameSupportedDefined By
                                                                                                  BasePath✗ToolingExtension
                                                                                                  Authorizations✗ToolingExtension
                                                                                                  UserAgent✗ToolingExtension

                                                                                                  Data Type Feature

                                                                                                  NameSupportedDefined By
                                                                                                  Custom✗OAS2,OAS3
                                                                                                  Int32✓OAS2,OAS3
                                                                                                  Int64✓OAS2,OAS3
                                                                                                  Float✓OAS2,OAS3
                                                                                                  Double✓OAS2,OAS3
                                                                                                  Decimal✓ToolingExtension
                                                                                                  String✓OAS2,OAS3
                                                                                                  Byte✓OAS2,OAS3
                                                                                                  Binary✓OAS2,OAS3
                                                                                                  Boolean✓OAS2,OAS3
                                                                                                  Date✓OAS2,OAS3
                                                                                                  DateTime✓OAS2,OAS3
                                                                                                  Password✓OAS2,OAS3
                                                                                                  File✓OAS2
                                                                                                  Array✓OAS2,OAS3
                                                                                                  Maps✓ToolingExtension
                                                                                                  CollectionFormat✓OAS2
                                                                                                  CollectionFormatMulti✓OAS2
                                                                                                  Enum✓OAS2,OAS3
                                                                                                  ArrayOfEnum✓ToolingExtension
                                                                                                  ArrayOfModel✓ToolingExtension
                                                                                                  ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                  ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                  ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                  MapOfEnum✓ToolingExtension
                                                                                                  MapOfModel✓ToolingExtension
                                                                                                  MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                  MapOfCollectionOfModel✓ToolingExtension
                                                                                                  MapOfCollectionOfEnum✓ToolingExtension

                                                                                                  Documentation Feature

                                                                                                  NameSupportedDefined By
                                                                                                  Readme✓ToolingExtension
                                                                                                  Model✓ToolingExtension
                                                                                                  Api✓ToolingExtension

                                                                                                  Global Feature

                                                                                                  NameSupportedDefined By
                                                                                                  Host✓OAS2,OAS3
                                                                                                  BasePath✓OAS2,OAS3
                                                                                                  Info✓OAS2,OAS3
                                                                                                  Schemes✗OAS2,OAS3
                                                                                                  PartialSchemes✓OAS2,OAS3
                                                                                                  Consumes✓OAS2
                                                                                                  Produces✓OAS2
                                                                                                  ExternalDocumentation✓OAS2,OAS3
                                                                                                  Examples✓OAS2,OAS3
                                                                                                  XMLStructureDefinitions✗OAS2,OAS3
                                                                                                  MultiServer✗OAS3
                                                                                                  ParameterizedServer✗OAS3
                                                                                                  ParameterStyling✗OAS3
                                                                                                  Callbacks✗OAS3
                                                                                                  LinkObjects✗OAS3

                                                                                                  Parameter Feature

                                                                                                  NameSupportedDefined By
                                                                                                  Path✓OAS2,OAS3
                                                                                                  Query✓OAS2,OAS3
                                                                                                  Header✓OAS2,OAS3
                                                                                                  Body✓OAS2
                                                                                                  FormUnencoded✓OAS2
                                                                                                  FormMultipart✓OAS2
                                                                                                  Cookie✗OAS3

                                                                                                  Schema Support Feature

                                                                                                  NameSupportedDefined By
                                                                                                  Simple✓OAS2,OAS3
                                                                                                  Composite✓OAS2,OAS3
                                                                                                  Polymorphism✗OAS2,OAS3
                                                                                                  Union✗OAS3

                                                                                                  Security Feature

                                                                                                  NameSupportedDefined By
                                                                                                  BasicAuth✗OAS2,OAS3
                                                                                                  ApiKey✗OAS2,OAS3
                                                                                                  OpenIDConnect✗OAS3
                                                                                                  BearerToken✗OAS3
                                                                                                  OAuth2_Implicit✗OAS2,OAS3
                                                                                                  OAuth2_Password✗OAS2,OAS3
                                                                                                  OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                  OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                  Wire Format Feature

                                                                                                  NameSupportedDefined By
                                                                                                  JSON✓OAS2,OAS3
                                                                                                  XML✗OAS2,OAS3
                                                                                                  PROTOBUF✗ToolingExtension
                                                                                                  Custom✗OAS2,OAS3
                                                                                                  Edit this page
                                                                                                  Last updated on by Jim Schubert
                                                                                                  +

                                                                                                  Config Options for nodejs-server-deprecated

                                                                                                  OptionDescriptionValuesDefault
                                                                                                  allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                  ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                  exportedNameWhen 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
                                                                                                  googleCloudFunctionsWhen 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
                                                                                                  prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                  serverPortTCP port to listen on.null
                                                                                                  sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                  sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                  IMPORT MAPPING

                                                                                                  Type/AliasImports
                                                                                                  Arrayjava.util.List
                                                                                                  ArrayListjava.util.ArrayList
                                                                                                  BigDecimaljava.math.BigDecimal
                                                                                                  Datejava.util.Date
                                                                                                  DateTimeorg.joda.time.*
                                                                                                  Filejava.io.File
                                                                                                  HashMapjava.util.HashMap
                                                                                                  Listjava.util.*
                                                                                                  LocalDateorg.joda.time.*
                                                                                                  LocalDateTimeorg.joda.time.*
                                                                                                  LocalTimeorg.joda.time.*
                                                                                                  Mapjava.util.Map
                                                                                                  Setjava.util.*
                                                                                                  Timestampjava.sql.Timestamp
                                                                                                  URIjava.net.URI
                                                                                                  UUIDjava.util.UUID

                                                                                                  INSTANTIATION TYPES

                                                                                                  Type/AliasInstantiated By

                                                                                                  LANGUAGE PRIMITIVES

                                                                                                    RESERVED WORDS

                                                                                                    • break
                                                                                                    • case
                                                                                                    • catch
                                                                                                    • class
                                                                                                    • const
                                                                                                    • continue
                                                                                                    • debugger
                                                                                                    • default
                                                                                                    • delete
                                                                                                    • do
                                                                                                    • else
                                                                                                    • export
                                                                                                    • extends
                                                                                                    • finally
                                                                                                    • for
                                                                                                    • function
                                                                                                    • if
                                                                                                    • import
                                                                                                    • in
                                                                                                    • instanceof
                                                                                                    • let
                                                                                                    • new
                                                                                                    • return
                                                                                                    • super
                                                                                                    • switch
                                                                                                    • this
                                                                                                    • throw
                                                                                                    • try
                                                                                                    • typeof
                                                                                                    • var
                                                                                                    • void
                                                                                                    • while
                                                                                                    • with
                                                                                                    • yield

                                                                                                    FEATURE SET

                                                                                                    Client Modification Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasePath✗ToolingExtension
                                                                                                    Authorizations✗ToolingExtension
                                                                                                    UserAgent✗ToolingExtension

                                                                                                    Data Type Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Int32✓OAS2,OAS3
                                                                                                    Int64✓OAS2,OAS3
                                                                                                    Float✓OAS2,OAS3
                                                                                                    Double✓OAS2,OAS3
                                                                                                    Decimal✓ToolingExtension
                                                                                                    String✓OAS2,OAS3
                                                                                                    Byte✓OAS2,OAS3
                                                                                                    Binary✓OAS2,OAS3
                                                                                                    Boolean✓OAS2,OAS3
                                                                                                    Date✓OAS2,OAS3
                                                                                                    DateTime✓OAS2,OAS3
                                                                                                    Password✓OAS2,OAS3
                                                                                                    File✓OAS2
                                                                                                    Array✓OAS2,OAS3
                                                                                                    Maps✓ToolingExtension
                                                                                                    CollectionFormat✓OAS2
                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                    Enum✓OAS2,OAS3
                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                    MapOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                    Documentation Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Readme✓ToolingExtension
                                                                                                    Model✓ToolingExtension
                                                                                                    Api✓ToolingExtension

                                                                                                    Global Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Host✓OAS2,OAS3
                                                                                                    BasePath✓OAS2,OAS3
                                                                                                    Info✓OAS2,OAS3
                                                                                                    Schemes✗OAS2,OAS3
                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                    Consumes✓OAS2
                                                                                                    Produces✓OAS2
                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                    Examples✓OAS2,OAS3
                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                    MultiServer✗OAS3
                                                                                                    ParameterizedServer✗OAS3
                                                                                                    ParameterStyling✗OAS3
                                                                                                    Callbacks✗OAS3
                                                                                                    LinkObjects✗OAS3

                                                                                                    Parameter Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Path✓OAS2,OAS3
                                                                                                    Query✓OAS2,OAS3
                                                                                                    Header✓OAS2,OAS3
                                                                                                    Body✓OAS2
                                                                                                    FormUnencoded✓OAS2
                                                                                                    FormMultipart✓OAS2
                                                                                                    Cookie✗OAS3

                                                                                                    Schema Support Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Simple✓OAS2,OAS3
                                                                                                    Composite✓OAS2,OAS3
                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                    Union✗OAS3

                                                                                                    Security Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                    OpenIDConnect✗OAS3
                                                                                                    BearerToken✗OAS3
                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                    Wire Format Feature

                                                                                                    NameSupportedDefined By
                                                                                                    JSON✓OAS2,OAS3
                                                                                                    XML✗OAS2,OAS3
                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Edit this page
                                                                                                    Last updated on by Jim Schubert
                                                                                                    - + - + - + diff --git a/docs/generators/objc/index.html b/docs/generators/objc/index.html index 6139ec71b5e..33e9245d941 100644 --- a/docs/generators/objc/index.html +++ b/docs/generators/objc/index.html @@ -21,26 +21,26 @@ - +
                                                                                                    -

                                                                                                    Config Options for objc

                                                                                                    OptionDescriptionValuesDefault
                                                                                                    authorEmailEmail to use in the podspec file.team@openapitools.org
                                                                                                    authorNameName to use in the podspec file.OpenAPI
                                                                                                    classPrefixprefix for generated classes (convention: Abbreviation of pod name e.g. HN for HackerNews).`OAI
                                                                                                    coreDataShould generate core data modelsfalse
                                                                                                    gitRepoURLURL for the git repo where this podspec should point to.https://github.com/openapitools/openapi-generator
                                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                    podNamecocoapods package name (convention: CameCase).OpenAPIClient
                                                                                                    podVersioncocoapods package version.1.0.0

                                                                                                    IMPORT MAPPING

                                                                                                    Type/AliasImports

                                                                                                    INSTANTIATION TYPES

                                                                                                    Type/AliasInstantiated By
                                                                                                    arrayNSMutableArray
                                                                                                    mapNSMutableDictionary

                                                                                                    LANGUAGE PRIMITIVES

                                                                                                    • BOOL
                                                                                                    • NSData
                                                                                                    • NSDate
                                                                                                    • NSNumber
                                                                                                    • NSObject
                                                                                                    • NSString
                                                                                                    • NSURL
                                                                                                    • bool

                                                                                                    RESERVED WORDS

                                                                                                    • _packed
                                                                                                    • authsettings
                                                                                                    • auto
                                                                                                    • bodyparam
                                                                                                    • break
                                                                                                    • case
                                                                                                    • cgfloat
                                                                                                    • char
                                                                                                    • class
                                                                                                    • const
                                                                                                    • continue
                                                                                                    • default
                                                                                                    • description
                                                                                                    • do
                                                                                                    • double
                                                                                                    • else
                                                                                                    • enum
                                                                                                    • extern
                                                                                                    • float
                                                                                                    • for
                                                                                                    • formparams
                                                                                                    • goto
                                                                                                    • headerparams
                                                                                                    • id
                                                                                                    • if
                                                                                                    • implementation
                                                                                                    • int
                                                                                                    • interface
                                                                                                    • localvarfiles
                                                                                                    • long
                                                                                                    • nonatomic
                                                                                                    • nsinteger
                                                                                                    • nsnumber
                                                                                                    • nsobject
                                                                                                    • pathparams
                                                                                                    • property
                                                                                                    • protocol
                                                                                                    • queryparams
                                                                                                    • readonly
                                                                                                    • readwrite
                                                                                                    • register
                                                                                                    • requestcontenttype
                                                                                                    • resourcepath
                                                                                                    • responsecontenttype
                                                                                                    • retain
                                                                                                    • return
                                                                                                    • short
                                                                                                    • signed
                                                                                                    • sizeof
                                                                                                    • static
                                                                                                    • strong
                                                                                                    • struct
                                                                                                    • switch
                                                                                                    • typedef
                                                                                                    • union
                                                                                                    • unsafe_unretained
                                                                                                    • unsigned
                                                                                                    • void
                                                                                                    • volatile
                                                                                                    • weak
                                                                                                    • while

                                                                                                    FEATURE SET

                                                                                                    Client Modification Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasePath✓ToolingExtension
                                                                                                    Authorizations✗ToolingExtension
                                                                                                    UserAgent✓ToolingExtension

                                                                                                    Data Type Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Int32✓OAS2,OAS3
                                                                                                    Int64✓OAS2,OAS3
                                                                                                    Float✓OAS2,OAS3
                                                                                                    Double✓OAS2,OAS3
                                                                                                    Decimal✓ToolingExtension
                                                                                                    String✓OAS2,OAS3
                                                                                                    Byte✓OAS2,OAS3
                                                                                                    Binary✓OAS2,OAS3
                                                                                                    Boolean✓OAS2,OAS3
                                                                                                    Date✓OAS2,OAS3
                                                                                                    DateTime✓OAS2,OAS3
                                                                                                    Password✓OAS2,OAS3
                                                                                                    File✓OAS2
                                                                                                    Array✓OAS2,OAS3
                                                                                                    Maps✓ToolingExtension
                                                                                                    CollectionFormat✓OAS2
                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                    Enum✓OAS2,OAS3
                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                    MapOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                    Documentation Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Readme✓ToolingExtension
                                                                                                    Model✓ToolingExtension
                                                                                                    Api✓ToolingExtension

                                                                                                    Global Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Host✓OAS2,OAS3
                                                                                                    BasePath✓OAS2,OAS3
                                                                                                    Info✓OAS2,OAS3
                                                                                                    Schemes✗OAS2,OAS3
                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                    Consumes✓OAS2
                                                                                                    Produces✓OAS2
                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                    Examples✓OAS2,OAS3
                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                    MultiServer✗OAS3
                                                                                                    ParameterizedServer✗OAS3
                                                                                                    ParameterStyling✗OAS3
                                                                                                    Callbacks✗OAS3
                                                                                                    LinkObjects✗OAS3

                                                                                                    Parameter Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Path✓OAS2,OAS3
                                                                                                    Query✓OAS2,OAS3
                                                                                                    Header✓OAS2,OAS3
                                                                                                    Body✓OAS2
                                                                                                    FormUnencoded✓OAS2
                                                                                                    FormMultipart✓OAS2
                                                                                                    Cookie✓OAS3

                                                                                                    Schema Support Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Simple✓OAS2,OAS3
                                                                                                    Composite✓OAS2,OAS3
                                                                                                    Polymorphism✓OAS2,OAS3
                                                                                                    Union✗OAS3

                                                                                                    Security Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                    OpenIDConnect✗OAS3
                                                                                                    BearerToken✗OAS3
                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                    Wire Format Feature

                                                                                                    NameSupportedDefined By
                                                                                                    JSON✓OAS2,OAS3
                                                                                                    XML✗OAS2,OAS3
                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Edit this page
                                                                                                    Last updated on by Jim Schubert
                                                                                                    +

                                                                                                    Config Options for objc

                                                                                                    OptionDescriptionValuesDefault
                                                                                                    authorEmailEmail to use in the podspec file.team@openapitools.org
                                                                                                    authorNameName to use in the podspec file.OpenAPI
                                                                                                    classPrefixprefix for generated classes (convention: Abbreviation of pod name e.g. HN for HackerNews).`OAI
                                                                                                    coreDataShould generate core data modelsfalse
                                                                                                    gitRepoURLURL for the git repo where this podspec should point to.https://github.com/openapitools/openapi-generator
                                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                    podNamecocoapods package name (convention: CameCase).OpenAPIClient
                                                                                                    podVersioncocoapods package version.1.0.0

                                                                                                    IMPORT MAPPING

                                                                                                    Type/AliasImports

                                                                                                    INSTANTIATION TYPES

                                                                                                    Type/AliasInstantiated By
                                                                                                    arrayNSMutableArray
                                                                                                    mapNSMutableDictionary

                                                                                                    LANGUAGE PRIMITIVES

                                                                                                    • BOOL
                                                                                                    • NSData
                                                                                                    • NSDate
                                                                                                    • NSNumber
                                                                                                    • NSObject
                                                                                                    • NSString
                                                                                                    • NSURL
                                                                                                    • bool

                                                                                                    RESERVED WORDS

                                                                                                    • _packed
                                                                                                    • authsettings
                                                                                                    • auto
                                                                                                    • bodyparam
                                                                                                    • break
                                                                                                    • case
                                                                                                    • cgfloat
                                                                                                    • char
                                                                                                    • class
                                                                                                    • const
                                                                                                    • continue
                                                                                                    • default
                                                                                                    • description
                                                                                                    • do
                                                                                                    • double
                                                                                                    • else
                                                                                                    • enum
                                                                                                    • extern
                                                                                                    • float
                                                                                                    • for
                                                                                                    • formparams
                                                                                                    • goto
                                                                                                    • headerparams
                                                                                                    • id
                                                                                                    • if
                                                                                                    • implementation
                                                                                                    • int
                                                                                                    • interface
                                                                                                    • localvarfiles
                                                                                                    • long
                                                                                                    • nonatomic
                                                                                                    • nsinteger
                                                                                                    • nsnumber
                                                                                                    • nsobject
                                                                                                    • pathparams
                                                                                                    • property
                                                                                                    • protocol
                                                                                                    • queryparams
                                                                                                    • readonly
                                                                                                    • readwrite
                                                                                                    • register
                                                                                                    • requestcontenttype
                                                                                                    • resourcepath
                                                                                                    • responsecontenttype
                                                                                                    • retain
                                                                                                    • return
                                                                                                    • short
                                                                                                    • signed
                                                                                                    • sizeof
                                                                                                    • static
                                                                                                    • strong
                                                                                                    • struct
                                                                                                    • switch
                                                                                                    • typedef
                                                                                                    • union
                                                                                                    • unsafe_unretained
                                                                                                    • unsigned
                                                                                                    • void
                                                                                                    • volatile
                                                                                                    • weak
                                                                                                    • while

                                                                                                    FEATURE SET

                                                                                                    Client Modification Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasePath✓ToolingExtension
                                                                                                    Authorizations✗ToolingExtension
                                                                                                    UserAgent✓ToolingExtension

                                                                                                    Data Type Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Int32✓OAS2,OAS3
                                                                                                    Int64✓OAS2,OAS3
                                                                                                    Float✓OAS2,OAS3
                                                                                                    Double✓OAS2,OAS3
                                                                                                    Decimal✓ToolingExtension
                                                                                                    String✓OAS2,OAS3
                                                                                                    Byte✓OAS2,OAS3
                                                                                                    Binary✓OAS2,OAS3
                                                                                                    Boolean✓OAS2,OAS3
                                                                                                    Date✓OAS2,OAS3
                                                                                                    DateTime✓OAS2,OAS3
                                                                                                    Password✓OAS2,OAS3
                                                                                                    File✓OAS2
                                                                                                    Array✓OAS2,OAS3
                                                                                                    Maps✓ToolingExtension
                                                                                                    CollectionFormat✓OAS2
                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                    Enum✓OAS2,OAS3
                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                    MapOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                    Documentation Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Readme✓ToolingExtension
                                                                                                    Model✓ToolingExtension
                                                                                                    Api✓ToolingExtension

                                                                                                    Global Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Host✓OAS2,OAS3
                                                                                                    BasePath✓OAS2,OAS3
                                                                                                    Info✓OAS2,OAS3
                                                                                                    Schemes✗OAS2,OAS3
                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                    Consumes✓OAS2
                                                                                                    Produces✓OAS2
                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                    Examples✓OAS2,OAS3
                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                    MultiServer✗OAS3
                                                                                                    ParameterizedServer✗OAS3
                                                                                                    ParameterStyling✗OAS3
                                                                                                    Callbacks✗OAS3
                                                                                                    LinkObjects✗OAS3

                                                                                                    Parameter Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Path✓OAS2,OAS3
                                                                                                    Query✓OAS2,OAS3
                                                                                                    Header✓OAS2,OAS3
                                                                                                    Body✓OAS2
                                                                                                    FormUnencoded✓OAS2
                                                                                                    FormMultipart✓OAS2
                                                                                                    Cookie✓OAS3

                                                                                                    Schema Support Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Simple✓OAS2,OAS3
                                                                                                    Composite✓OAS2,OAS3
                                                                                                    Polymorphism✓OAS2,OAS3
                                                                                                    Union✗OAS3

                                                                                                    Security Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                    OpenIDConnect✗OAS3
                                                                                                    BearerToken✗OAS3
                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                    Wire Format Feature

                                                                                                    NameSupportedDefined By
                                                                                                    JSON✓OAS2,OAS3
                                                                                                    XML✗OAS2,OAS3
                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Edit this page
                                                                                                    Last updated on by Jim Schubert
                                                                                                    - + - + - + diff --git a/docs/generators/ocaml/index.html b/docs/generators/ocaml/index.html index 5c49da4428b..ff6178ca32e 100644 --- a/docs/generators/ocaml/index.html +++ b/docs/generators/ocaml/index.html @@ -21,26 +21,26 @@ - +
                                                                                                    -

                                                                                                    Config Options for ocaml

                                                                                                    OptionDescriptionValuesDefault
                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                    IMPORT MAPPING

                                                                                                    Type/AliasImports
                                                                                                    Arrayjava.util.List
                                                                                                    ArrayListjava.util.ArrayList
                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                    Datejava.util.Date
                                                                                                    DateTimeorg.joda.time.*
                                                                                                    HashMapjava.util.HashMap
                                                                                                    Listjava.util.*
                                                                                                    LocalDateorg.joda.time.*
                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                    LocalTimeorg.joda.time.*
                                                                                                    Mapjava.util.Map
                                                                                                    Setjava.util.*
                                                                                                    Timestampjava.sql.Timestamp
                                                                                                    URIjava.net.URI
                                                                                                    UUIDjava.util.UUID

                                                                                                    INSTANTIATION TYPES

                                                                                                    Type/AliasInstantiated By

                                                                                                    LANGUAGE PRIMITIVES

                                                                                                    • Yojson.Safe.t
                                                                                                    • bool
                                                                                                    • bytes
                                                                                                    • char
                                                                                                    • float
                                                                                                    • int
                                                                                                    • int32
                                                                                                    • int64
                                                                                                    • list
                                                                                                    • string

                                                                                                    RESERVED WORDS

                                                                                                    • and
                                                                                                    • as
                                                                                                    • asr
                                                                                                    • assert
                                                                                                    • begin
                                                                                                    • class
                                                                                                    • constraint
                                                                                                    • do
                                                                                                    • done
                                                                                                    • downto
                                                                                                    • else
                                                                                                    • end
                                                                                                    • exception
                                                                                                    • external
                                                                                                    • false
                                                                                                    • for
                                                                                                    • fun
                                                                                                    • function
                                                                                                    • functor
                                                                                                    • if
                                                                                                    • in
                                                                                                    • include
                                                                                                    • inherit
                                                                                                    • initializer
                                                                                                    • land
                                                                                                    • lazy
                                                                                                    • let
                                                                                                    • lor
                                                                                                    • lsl
                                                                                                    • lsr
                                                                                                    • lxor
                                                                                                    • match
                                                                                                    • method
                                                                                                    • mod
                                                                                                    • module
                                                                                                    • mutable
                                                                                                    • new
                                                                                                    • nonrec
                                                                                                    • object
                                                                                                    • of
                                                                                                    • open
                                                                                                    • or
                                                                                                    • private
                                                                                                    • rec
                                                                                                    • result
                                                                                                    • sig
                                                                                                    • struct
                                                                                                    • then
                                                                                                    • to
                                                                                                    • true
                                                                                                    • try
                                                                                                    • type
                                                                                                    • val
                                                                                                    • virtual
                                                                                                    • when
                                                                                                    • while
                                                                                                    • with

                                                                                                    FEATURE SET

                                                                                                    Client Modification Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasePath✓ToolingExtension
                                                                                                    Authorizations✗ToolingExtension
                                                                                                    UserAgent✗ToolingExtension

                                                                                                    Data Type Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Int32✓OAS2,OAS3
                                                                                                    Int64✓OAS2,OAS3
                                                                                                    Float✓OAS2,OAS3
                                                                                                    Double✓OAS2,OAS3
                                                                                                    Decimal✓ToolingExtension
                                                                                                    String✓OAS2,OAS3
                                                                                                    Byte✓OAS2,OAS3
                                                                                                    Binary✓OAS2,OAS3
                                                                                                    Boolean✓OAS2,OAS3
                                                                                                    Date✓OAS2,OAS3
                                                                                                    DateTime✓OAS2,OAS3
                                                                                                    Password✓OAS2,OAS3
                                                                                                    File✓OAS2
                                                                                                    Array✓OAS2,OAS3
                                                                                                    Maps✓ToolingExtension
                                                                                                    CollectionFormat✓OAS2
                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                    Enum✓OAS2,OAS3
                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                    MapOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                    Documentation Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Readme✓ToolingExtension
                                                                                                    Model✓ToolingExtension
                                                                                                    Api✓ToolingExtension

                                                                                                    Global Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Host✓OAS2,OAS3
                                                                                                    BasePath✓OAS2,OAS3
                                                                                                    Info✓OAS2,OAS3
                                                                                                    Schemes✗OAS2,OAS3
                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                    Consumes✓OAS2
                                                                                                    Produces✓OAS2
                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                    Examples✓OAS2,OAS3
                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                    MultiServer✗OAS3
                                                                                                    ParameterizedServer✗OAS3
                                                                                                    ParameterStyling✗OAS3
                                                                                                    Callbacks✗OAS3
                                                                                                    LinkObjects✗OAS3

                                                                                                    Parameter Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Path✓OAS2,OAS3
                                                                                                    Query✓OAS2,OAS3
                                                                                                    Header✓OAS2,OAS3
                                                                                                    Body✓OAS2
                                                                                                    FormUnencoded✓OAS2
                                                                                                    FormMultipart✓OAS2
                                                                                                    Cookie✓OAS3

                                                                                                    Schema Support Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Simple✓OAS2,OAS3
                                                                                                    Composite✓OAS2,OAS3
                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                    Union✗OAS3

                                                                                                    Security Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                    OpenIDConnect✗OAS3
                                                                                                    BearerToken✗OAS3
                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                    Wire Format Feature

                                                                                                    NameSupportedDefined By
                                                                                                    JSON✓OAS2,OAS3
                                                                                                    XML✗OAS2,OAS3
                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Edit this page
                                                                                                    Last updated on by Jim Schubert
                                                                                                    +

                                                                                                    Config Options for ocaml

                                                                                                    OptionDescriptionValuesDefault
                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                    IMPORT MAPPING

                                                                                                    Type/AliasImports
                                                                                                    Arrayjava.util.List
                                                                                                    ArrayListjava.util.ArrayList
                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                    Datejava.util.Date
                                                                                                    DateTimeorg.joda.time.*
                                                                                                    HashMapjava.util.HashMap
                                                                                                    Listjava.util.*
                                                                                                    LocalDateorg.joda.time.*
                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                    LocalTimeorg.joda.time.*
                                                                                                    Mapjava.util.Map
                                                                                                    Setjava.util.*
                                                                                                    Timestampjava.sql.Timestamp
                                                                                                    URIjava.net.URI
                                                                                                    UUIDjava.util.UUID

                                                                                                    INSTANTIATION TYPES

                                                                                                    Type/AliasInstantiated By

                                                                                                    LANGUAGE PRIMITIVES

                                                                                                    • Yojson.Safe.t
                                                                                                    • bool
                                                                                                    • bytes
                                                                                                    • char
                                                                                                    • float
                                                                                                    • int
                                                                                                    • int32
                                                                                                    • int64
                                                                                                    • list
                                                                                                    • string

                                                                                                    RESERVED WORDS

                                                                                                    • and
                                                                                                    • as
                                                                                                    • asr
                                                                                                    • assert
                                                                                                    • begin
                                                                                                    • class
                                                                                                    • constraint
                                                                                                    • do
                                                                                                    • done
                                                                                                    • downto
                                                                                                    • else
                                                                                                    • end
                                                                                                    • exception
                                                                                                    • external
                                                                                                    • false
                                                                                                    • for
                                                                                                    • fun
                                                                                                    • function
                                                                                                    • functor
                                                                                                    • if
                                                                                                    • in
                                                                                                    • include
                                                                                                    • inherit
                                                                                                    • initializer
                                                                                                    • land
                                                                                                    • lazy
                                                                                                    • let
                                                                                                    • lor
                                                                                                    • lsl
                                                                                                    • lsr
                                                                                                    • lxor
                                                                                                    • match
                                                                                                    • method
                                                                                                    • mod
                                                                                                    • module
                                                                                                    • mutable
                                                                                                    • new
                                                                                                    • nonrec
                                                                                                    • object
                                                                                                    • of
                                                                                                    • open
                                                                                                    • or
                                                                                                    • private
                                                                                                    • rec
                                                                                                    • result
                                                                                                    • sig
                                                                                                    • struct
                                                                                                    • then
                                                                                                    • to
                                                                                                    • true
                                                                                                    • try
                                                                                                    • type
                                                                                                    • val
                                                                                                    • virtual
                                                                                                    • when
                                                                                                    • while
                                                                                                    • with

                                                                                                    FEATURE SET

                                                                                                    Client Modification Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasePath✓ToolingExtension
                                                                                                    Authorizations✗ToolingExtension
                                                                                                    UserAgent✗ToolingExtension

                                                                                                    Data Type Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Int32✓OAS2,OAS3
                                                                                                    Int64✓OAS2,OAS3
                                                                                                    Float✓OAS2,OAS3
                                                                                                    Double✓OAS2,OAS3
                                                                                                    Decimal✓ToolingExtension
                                                                                                    String✓OAS2,OAS3
                                                                                                    Byte✓OAS2,OAS3
                                                                                                    Binary✓OAS2,OAS3
                                                                                                    Boolean✓OAS2,OAS3
                                                                                                    Date✓OAS2,OAS3
                                                                                                    DateTime✓OAS2,OAS3
                                                                                                    Password✓OAS2,OAS3
                                                                                                    File✓OAS2
                                                                                                    Array✓OAS2,OAS3
                                                                                                    Maps✓ToolingExtension
                                                                                                    CollectionFormat✓OAS2
                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                    Enum✓OAS2,OAS3
                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                    MapOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                    Documentation Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Readme✓ToolingExtension
                                                                                                    Model✓ToolingExtension
                                                                                                    Api✓ToolingExtension

                                                                                                    Global Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Host✓OAS2,OAS3
                                                                                                    BasePath✓OAS2,OAS3
                                                                                                    Info✓OAS2,OAS3
                                                                                                    Schemes✗OAS2,OAS3
                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                    Consumes✓OAS2
                                                                                                    Produces✓OAS2
                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                    Examples✓OAS2,OAS3
                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                    MultiServer✗OAS3
                                                                                                    ParameterizedServer✗OAS3
                                                                                                    ParameterStyling✗OAS3
                                                                                                    Callbacks✗OAS3
                                                                                                    LinkObjects✗OAS3

                                                                                                    Parameter Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Path✓OAS2,OAS3
                                                                                                    Query✓OAS2,OAS3
                                                                                                    Header✓OAS2,OAS3
                                                                                                    Body✓OAS2
                                                                                                    FormUnencoded✓OAS2
                                                                                                    FormMultipart✓OAS2
                                                                                                    Cookie✓OAS3

                                                                                                    Schema Support Feature

                                                                                                    NameSupportedDefined By
                                                                                                    Simple✓OAS2,OAS3
                                                                                                    Composite✓OAS2,OAS3
                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                    Union✗OAS3

                                                                                                    Security Feature

                                                                                                    NameSupportedDefined By
                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                    OpenIDConnect✗OAS3
                                                                                                    BearerToken✗OAS3
                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                    Wire Format Feature

                                                                                                    NameSupportedDefined By
                                                                                                    JSON✓OAS2,OAS3
                                                                                                    XML✗OAS2,OAS3
                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                    Custom✗OAS2,OAS3
                                                                                                    Edit this page
                                                                                                    Last updated on by Jim Schubert
                                                                                                    - + - + - + diff --git a/docs/generators/openapi-yaml/index.html b/docs/generators/openapi-yaml/index.html index 03e4538ef50..5e03e9465a5 100644 --- a/docs/generators/openapi-yaml/index.html +++ b/docs/generators/openapi-yaml/index.html @@ -21,26 +21,26 @@ - +
                                                                                                    -

                                                                                                    Config Options for openapi-yaml

                                                                                                    OptionDescriptionValuesDefault
                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                    outputFileOutput filenameopenapi/openapi.yaml
                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                    IMPORT MAPPING

                                                                                                    Type/AliasImports
                                                                                                    Arrayjava.util.List
                                                                                                    ArrayListjava.util.ArrayList
                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                    Datejava.util.Date
                                                                                                    DateTimeorg.joda.time.*
                                                                                                    Filejava.io.File
                                                                                                    HashMapjava.util.HashMap
                                                                                                    Listjava.util.*
                                                                                                    LocalDateorg.joda.time.*
                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                    LocalTimeorg.joda.time.*
                                                                                                    Mapjava.util.Map
                                                                                                    Setjava.util.*
                                                                                                    Timestampjava.sql.Timestamp
                                                                                                    URIjava.net.URI
                                                                                                    UUIDjava.util.UUID

                                                                                                    INSTANTIATION TYPES

                                                                                                    Type/AliasInstantiated By

                                                                                                    LANGUAGE PRIMITIVES

                                                                                                      RESERVED WORDS

                                                                                                        FEATURE SET

                                                                                                        Client Modification Feature

                                                                                                        NameSupportedDefined By
                                                                                                        BasePath✗ToolingExtension
                                                                                                        Authorizations✗ToolingExtension
                                                                                                        UserAgent✗ToolingExtension

                                                                                                        Data Type Feature

                                                                                                        NameSupportedDefined By
                                                                                                        Custom✓OAS2,OAS3
                                                                                                        Int32✓OAS2,OAS3
                                                                                                        Int64✓OAS2,OAS3
                                                                                                        Float✓OAS2,OAS3
                                                                                                        Double✓OAS2,OAS3
                                                                                                        Decimal✓ToolingExtension
                                                                                                        String✓OAS2,OAS3
                                                                                                        Byte✓OAS2,OAS3
                                                                                                        Binary✓OAS2,OAS3
                                                                                                        Boolean✓OAS2,OAS3
                                                                                                        Date✓OAS2,OAS3
                                                                                                        DateTime✓OAS2,OAS3
                                                                                                        Password✓OAS2,OAS3
                                                                                                        File✓OAS2
                                                                                                        Array✓OAS2,OAS3
                                                                                                        Maps✓ToolingExtension
                                                                                                        CollectionFormat✓OAS2
                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                        Enum✓OAS2,OAS3
                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                        MapOfModel✓ToolingExtension
                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                        Documentation Feature

                                                                                                        NameSupportedDefined By
                                                                                                        Readme✓ToolingExtension
                                                                                                        Model✓ToolingExtension
                                                                                                        Api✓ToolingExtension

                                                                                                        Global Feature

                                                                                                        NameSupportedDefined By
                                                                                                        Host✓OAS2,OAS3
                                                                                                        BasePath✓OAS2,OAS3
                                                                                                        Info✓OAS2,OAS3
                                                                                                        Schemes✓OAS2,OAS3
                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                        Consumes✓OAS2
                                                                                                        Produces✓OAS2
                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                        Examples✓OAS2,OAS3
                                                                                                        XMLStructureDefinitions✓OAS2,OAS3
                                                                                                        MultiServer✓OAS3
                                                                                                        ParameterizedServer✓OAS3
                                                                                                        ParameterStyling✓OAS3
                                                                                                        Callbacks✓OAS3
                                                                                                        LinkObjects✓OAS3

                                                                                                        Parameter Feature

                                                                                                        NameSupportedDefined By
                                                                                                        Path✓OAS2,OAS3
                                                                                                        Query✓OAS2,OAS3
                                                                                                        Header✓OAS2,OAS3
                                                                                                        Body✓OAS2
                                                                                                        FormUnencoded✓OAS2
                                                                                                        FormMultipart✓OAS2
                                                                                                        Cookie✓OAS3

                                                                                                        Schema Support Feature

                                                                                                        NameSupportedDefined By
                                                                                                        Simple✓OAS2,OAS3
                                                                                                        Composite✓OAS2,OAS3
                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                        Union✓OAS3

                                                                                                        Security Feature

                                                                                                        NameSupportedDefined By
                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                        OpenIDConnect✓OAS3
                                                                                                        BearerToken✓OAS3
                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                        Wire Format Feature

                                                                                                        NameSupportedDefined By
                                                                                                        JSON✓OAS2,OAS3
                                                                                                        XML✓OAS2,OAS3
                                                                                                        PROTOBUF✓ToolingExtension
                                                                                                        Custom✓OAS2,OAS3
                                                                                                        Edit this page
                                                                                                        Last updated on by Jim Schubert
                                                                                                        +

                                                                                                        Config Options for openapi-yaml

                                                                                                        OptionDescriptionValuesDefault
                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                        outputFileOutput filenameopenapi/openapi.yaml
                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                        IMPORT MAPPING

                                                                                                        Type/AliasImports
                                                                                                        Arrayjava.util.List
                                                                                                        ArrayListjava.util.ArrayList
                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                        Datejava.util.Date
                                                                                                        DateTimeorg.joda.time.*
                                                                                                        Filejava.io.File
                                                                                                        HashMapjava.util.HashMap
                                                                                                        Listjava.util.*
                                                                                                        LocalDateorg.joda.time.*
                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                        LocalTimeorg.joda.time.*
                                                                                                        Mapjava.util.Map
                                                                                                        Setjava.util.*
                                                                                                        Timestampjava.sql.Timestamp
                                                                                                        URIjava.net.URI
                                                                                                        UUIDjava.util.UUID

                                                                                                        INSTANTIATION TYPES

                                                                                                        Type/AliasInstantiated By

                                                                                                        LANGUAGE PRIMITIVES

                                                                                                          RESERVED WORDS

                                                                                                            FEATURE SET

                                                                                                            Client Modification Feature

                                                                                                            NameSupportedDefined By
                                                                                                            BasePath✗ToolingExtension
                                                                                                            Authorizations✗ToolingExtension
                                                                                                            UserAgent✗ToolingExtension

                                                                                                            Data Type Feature

                                                                                                            NameSupportedDefined By
                                                                                                            Custom✓OAS2,OAS3
                                                                                                            Int32✓OAS2,OAS3
                                                                                                            Int64✓OAS2,OAS3
                                                                                                            Float✓OAS2,OAS3
                                                                                                            Double✓OAS2,OAS3
                                                                                                            Decimal✓ToolingExtension
                                                                                                            String✓OAS2,OAS3
                                                                                                            Byte✓OAS2,OAS3
                                                                                                            Binary✓OAS2,OAS3
                                                                                                            Boolean✓OAS2,OAS3
                                                                                                            Date✓OAS2,OAS3
                                                                                                            DateTime✓OAS2,OAS3
                                                                                                            Password✓OAS2,OAS3
                                                                                                            File✓OAS2
                                                                                                            Array✓OAS2,OAS3
                                                                                                            Maps✓ToolingExtension
                                                                                                            CollectionFormat✓OAS2
                                                                                                            CollectionFormatMulti✓OAS2
                                                                                                            Enum✓OAS2,OAS3
                                                                                                            ArrayOfEnum✓ToolingExtension
                                                                                                            ArrayOfModel✓ToolingExtension
                                                                                                            ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                            ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                            ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                            MapOfEnum✓ToolingExtension
                                                                                                            MapOfModel✓ToolingExtension
                                                                                                            MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                            MapOfCollectionOfModel✓ToolingExtension
                                                                                                            MapOfCollectionOfEnum✓ToolingExtension

                                                                                                            Documentation Feature

                                                                                                            NameSupportedDefined By
                                                                                                            Readme✓ToolingExtension
                                                                                                            Model✓ToolingExtension
                                                                                                            Api✓ToolingExtension

                                                                                                            Global Feature

                                                                                                            NameSupportedDefined By
                                                                                                            Host✓OAS2,OAS3
                                                                                                            BasePath✓OAS2,OAS3
                                                                                                            Info✓OAS2,OAS3
                                                                                                            Schemes✓OAS2,OAS3
                                                                                                            PartialSchemes✓OAS2,OAS3
                                                                                                            Consumes✓OAS2
                                                                                                            Produces✓OAS2
                                                                                                            ExternalDocumentation✓OAS2,OAS3
                                                                                                            Examples✓OAS2,OAS3
                                                                                                            XMLStructureDefinitions✓OAS2,OAS3
                                                                                                            MultiServer✓OAS3
                                                                                                            ParameterizedServer✓OAS3
                                                                                                            ParameterStyling✓OAS3
                                                                                                            Callbacks✓OAS3
                                                                                                            LinkObjects✓OAS3

                                                                                                            Parameter Feature

                                                                                                            NameSupportedDefined By
                                                                                                            Path✓OAS2,OAS3
                                                                                                            Query✓OAS2,OAS3
                                                                                                            Header✓OAS2,OAS3
                                                                                                            Body✓OAS2
                                                                                                            FormUnencoded✓OAS2
                                                                                                            FormMultipart✓OAS2
                                                                                                            Cookie✓OAS3

                                                                                                            Schema Support Feature

                                                                                                            NameSupportedDefined By
                                                                                                            Simple✓OAS2,OAS3
                                                                                                            Composite✓OAS2,OAS3
                                                                                                            Polymorphism✓OAS2,OAS3
                                                                                                            Union✓OAS3

                                                                                                            Security Feature

                                                                                                            NameSupportedDefined By
                                                                                                            BasicAuth✓OAS2,OAS3
                                                                                                            ApiKey✓OAS2,OAS3
                                                                                                            OpenIDConnect✓OAS3
                                                                                                            BearerToken✓OAS3
                                                                                                            OAuth2_Implicit✓OAS2,OAS3
                                                                                                            OAuth2_Password✓OAS2,OAS3
                                                                                                            OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                            OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                            Wire Format Feature

                                                                                                            NameSupportedDefined By
                                                                                                            JSON✓OAS2,OAS3
                                                                                                            XML✓OAS2,OAS3
                                                                                                            PROTOBUF✓ToolingExtension
                                                                                                            Custom✓OAS2,OAS3
                                                                                                            Edit this page
                                                                                                            Last updated on by Jim Schubert
                                                                                                            - + - + - + diff --git a/docs/generators/openapi/index.html b/docs/generators/openapi/index.html index ded6795cc01..d9c3835aeb8 100644 --- a/docs/generators/openapi/index.html +++ b/docs/generators/openapi/index.html @@ -21,26 +21,26 @@ - +
                                                                                                            -

                                                                                                            Config Options for openapi

                                                                                                            OptionDescriptionValuesDefault
                                                                                                            allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                            ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                            prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                            sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                            sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                            IMPORT MAPPING

                                                                                                            Type/AliasImports
                                                                                                            Arrayjava.util.List
                                                                                                            ArrayListjava.util.ArrayList
                                                                                                            BigDecimaljava.math.BigDecimal
                                                                                                            Datejava.util.Date
                                                                                                            DateTimeorg.joda.time.*
                                                                                                            Filejava.io.File
                                                                                                            HashMapjava.util.HashMap
                                                                                                            Listjava.util.*
                                                                                                            LocalDateorg.joda.time.*
                                                                                                            LocalDateTimeorg.joda.time.*
                                                                                                            LocalTimeorg.joda.time.*
                                                                                                            Mapjava.util.Map
                                                                                                            Setjava.util.*
                                                                                                            Timestampjava.sql.Timestamp
                                                                                                            URIjava.net.URI
                                                                                                            UUIDjava.util.UUID

                                                                                                            INSTANTIATION TYPES

                                                                                                            Type/AliasInstantiated By

                                                                                                            LANGUAGE PRIMITIVES

                                                                                                              RESERVED WORDS

                                                                                                                FEATURE SET

                                                                                                                Client Modification Feature

                                                                                                                NameSupportedDefined By
                                                                                                                BasePath✗ToolingExtension
                                                                                                                Authorizations✗ToolingExtension
                                                                                                                UserAgent✗ToolingExtension

                                                                                                                Data Type Feature

                                                                                                                NameSupportedDefined By
                                                                                                                Custom✓OAS2,OAS3
                                                                                                                Int32✓OAS2,OAS3
                                                                                                                Int64✓OAS2,OAS3
                                                                                                                Float✓OAS2,OAS3
                                                                                                                Double✓OAS2,OAS3
                                                                                                                Decimal✓ToolingExtension
                                                                                                                String✓OAS2,OAS3
                                                                                                                Byte✓OAS2,OAS3
                                                                                                                Binary✓OAS2,OAS3
                                                                                                                Boolean✓OAS2,OAS3
                                                                                                                Date✓OAS2,OAS3
                                                                                                                DateTime✓OAS2,OAS3
                                                                                                                Password✓OAS2,OAS3
                                                                                                                File✓OAS2
                                                                                                                Array✓OAS2,OAS3
                                                                                                                Maps✓ToolingExtension
                                                                                                                CollectionFormat✓OAS2
                                                                                                                CollectionFormatMulti✓OAS2
                                                                                                                Enum✓OAS2,OAS3
                                                                                                                ArrayOfEnum✓ToolingExtension
                                                                                                                ArrayOfModel✓ToolingExtension
                                                                                                                ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                MapOfEnum✓ToolingExtension
                                                                                                                MapOfModel✓ToolingExtension
                                                                                                                MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                MapOfCollectionOfModel✓ToolingExtension
                                                                                                                MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                Documentation Feature

                                                                                                                NameSupportedDefined By
                                                                                                                Readme✓ToolingExtension
                                                                                                                Model✓ToolingExtension
                                                                                                                Api✓ToolingExtension

                                                                                                                Global Feature

                                                                                                                NameSupportedDefined By
                                                                                                                Host✓OAS2,OAS3
                                                                                                                BasePath✓OAS2,OAS3
                                                                                                                Info✓OAS2,OAS3
                                                                                                                Schemes✓OAS2,OAS3
                                                                                                                PartialSchemes✓OAS2,OAS3
                                                                                                                Consumes✓OAS2
                                                                                                                Produces✓OAS2
                                                                                                                ExternalDocumentation✓OAS2,OAS3
                                                                                                                Examples✓OAS2,OAS3
                                                                                                                XMLStructureDefinitions✓OAS2,OAS3
                                                                                                                MultiServer✓OAS3
                                                                                                                ParameterizedServer✓OAS3
                                                                                                                ParameterStyling✓OAS3
                                                                                                                Callbacks✓OAS3
                                                                                                                LinkObjects✓OAS3

                                                                                                                Parameter Feature

                                                                                                                NameSupportedDefined By
                                                                                                                Path✓OAS2,OAS3
                                                                                                                Query✓OAS2,OAS3
                                                                                                                Header✓OAS2,OAS3
                                                                                                                Body✓OAS2
                                                                                                                FormUnencoded✓OAS2
                                                                                                                FormMultipart✓OAS2
                                                                                                                Cookie✓OAS3

                                                                                                                Schema Support Feature

                                                                                                                NameSupportedDefined By
                                                                                                                Simple✓OAS2,OAS3
                                                                                                                Composite✓OAS2,OAS3
                                                                                                                Polymorphism✓OAS2,OAS3
                                                                                                                Union✓OAS3

                                                                                                                Security Feature

                                                                                                                NameSupportedDefined By
                                                                                                                BasicAuth✓OAS2,OAS3
                                                                                                                ApiKey✓OAS2,OAS3
                                                                                                                OpenIDConnect✓OAS3
                                                                                                                BearerToken✓OAS3
                                                                                                                OAuth2_Implicit✓OAS2,OAS3
                                                                                                                OAuth2_Password✓OAS2,OAS3
                                                                                                                OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                Wire Format Feature

                                                                                                                NameSupportedDefined By
                                                                                                                JSON✓OAS2,OAS3
                                                                                                                XML✓OAS2,OAS3
                                                                                                                PROTOBUF✓ToolingExtension
                                                                                                                Custom✓OAS2,OAS3
                                                                                                                Edit this page
                                                                                                                Last updated on by Jim Schubert
                                                                                                                +

                                                                                                                Config Options for openapi

                                                                                                                OptionDescriptionValuesDefault
                                                                                                                allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                IMPORT MAPPING

                                                                                                                Type/AliasImports
                                                                                                                Arrayjava.util.List
                                                                                                                ArrayListjava.util.ArrayList
                                                                                                                BigDecimaljava.math.BigDecimal
                                                                                                                Datejava.util.Date
                                                                                                                DateTimeorg.joda.time.*
                                                                                                                Filejava.io.File
                                                                                                                HashMapjava.util.HashMap
                                                                                                                Listjava.util.*
                                                                                                                LocalDateorg.joda.time.*
                                                                                                                LocalDateTimeorg.joda.time.*
                                                                                                                LocalTimeorg.joda.time.*
                                                                                                                Mapjava.util.Map
                                                                                                                Setjava.util.*
                                                                                                                Timestampjava.sql.Timestamp
                                                                                                                URIjava.net.URI
                                                                                                                UUIDjava.util.UUID

                                                                                                                INSTANTIATION TYPES

                                                                                                                Type/AliasInstantiated By

                                                                                                                LANGUAGE PRIMITIVES

                                                                                                                  RESERVED WORDS

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✓OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✓OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✓OAS2,OAS3
                                                                                                                    MultiServer✓OAS3
                                                                                                                    ParameterizedServer✓OAS3
                                                                                                                    ParameterStyling✓OAS3
                                                                                                                    Callbacks✓OAS3
                                                                                                                    LinkObjects✓OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✓OAS2,OAS3
                                                                                                                    Union✓OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                                    OpenIDConnect✓OAS3
                                                                                                                    BearerToken✓OAS3
                                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                                    OAuth2_Password✓OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✓ToolingExtension
                                                                                                                    Custom✓OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/perl/index.html b/docs/generators/perl/index.html index f8819c3caba..0daae5c10f3 100644 --- a/docs/generators/perl/index.html +++ b/docs/generators/perl/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for perl

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                    moduleNamePerl module name (convention: CamelCase or Long::Module).OpenAPIClient
                                                                                                                    moduleVersionPerl module version.1.0.0
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • ARRAY
                                                                                                                    • DateTime
                                                                                                                    • HASH
                                                                                                                    • boolean
                                                                                                                    • double
                                                                                                                    • int
                                                                                                                    • object
                                                                                                                    • string

                                                                                                                    RESERVED WORDS

                                                                                                                    • __end__
                                                                                                                    • __file__
                                                                                                                    • __line__
                                                                                                                    • __package__
                                                                                                                    • and
                                                                                                                    • cmp
                                                                                                                    • continue
                                                                                                                    • core
                                                                                                                    • do
                                                                                                                    • else
                                                                                                                    • elsif
                                                                                                                    • eq
                                                                                                                    • exp
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • ge
                                                                                                                    • gt
                                                                                                                    • if
                                                                                                                    • le
                                                                                                                    • lock
                                                                                                                    • lt
                                                                                                                    • m
                                                                                                                    • ne
                                                                                                                    • no
                                                                                                                    • or
                                                                                                                    • package
                                                                                                                    • q
                                                                                                                    • qq
                                                                                                                    • qr
                                                                                                                    • qw
                                                                                                                    • qx
                                                                                                                    • return
                                                                                                                    • s
                                                                                                                    • sub
                                                                                                                    • tr
                                                                                                                    • unless
                                                                                                                    • until
                                                                                                                    • while
                                                                                                                    • xor
                                                                                                                    • y

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✓ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✓ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✓OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✓OAS3
                                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for perl

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                    moduleNamePerl module name (convention: CamelCase or Long::Module).OpenAPIClient
                                                                                                                    moduleVersionPerl module version.1.0.0
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • ARRAY
                                                                                                                    • DateTime
                                                                                                                    • HASH
                                                                                                                    • boolean
                                                                                                                    • double
                                                                                                                    • int
                                                                                                                    • object
                                                                                                                    • string

                                                                                                                    RESERVED WORDS

                                                                                                                    • __end__
                                                                                                                    • __file__
                                                                                                                    • __line__
                                                                                                                    • __package__
                                                                                                                    • and
                                                                                                                    • cmp
                                                                                                                    • continue
                                                                                                                    • core
                                                                                                                    • do
                                                                                                                    • else
                                                                                                                    • elsif
                                                                                                                    • eq
                                                                                                                    • exp
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • ge
                                                                                                                    • gt
                                                                                                                    • if
                                                                                                                    • le
                                                                                                                    • lock
                                                                                                                    • lt
                                                                                                                    • m
                                                                                                                    • ne
                                                                                                                    • no
                                                                                                                    • or
                                                                                                                    • package
                                                                                                                    • q
                                                                                                                    • qq
                                                                                                                    • qr
                                                                                                                    • qw
                                                                                                                    • qx
                                                                                                                    • return
                                                                                                                    • s
                                                                                                                    • sub
                                                                                                                    • tr
                                                                                                                    • unless
                                                                                                                    • until
                                                                                                                    • while
                                                                                                                    • xor
                                                                                                                    • y

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✓ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✓ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✓OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✓OAS3
                                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-laravel/index.html b/docs/generators/php-laravel/index.html index 32d10b6cb00..8b00c51ee34 100644 --- a/docs/generators/php-laravel/index.html +++ b/docs/generators/php-laravel/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-laravel

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-laravel

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-lumen/index.html b/docs/generators/php-lumen/index.html index c9f7a0b7683..aafc434218a 100644 --- a/docs/generators/php-lumen/index.html +++ b/docs/generators/php-lumen/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-lumen

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-lumen

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-silex/index.html b/docs/generators/php-silex/index.html index 099142f836a..62c1bc5f75d 100644 --- a/docs/generators/php-silex/index.html +++ b/docs/generators/php-silex/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-silex

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • boolean
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-silex

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • boolean
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-slim-deprecated/index.html b/docs/generators/php-slim-deprecated/index.html index 5f95896a246..02d255f9984 100644 --- a/docs/generators/php-slim-deprecated/index.html +++ b/docs/generators/php-slim-deprecated/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-slim-deprecated

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.camelCase

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-slim-deprecated

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.camelCase

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-slim4/index.html b/docs/generators/php-slim4/index.html index eabb632bf1d..6d3d40d0937 100644 --- a/docs/generators/php-slim4/index.html +++ b/docs/generators/php-slim4/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-slim4

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    psr7ImplementationSlim 4 provides its own PSR-7 implementation so that it works out of the box. However, you are free to replace Slim’s default PSR-7 objects with a third-party implementation. Ref: https://www.slimframework.com/docs/v4/concepts/value-objects.html
                                                                                                                    slim-psr7
                                                                                                                    Slim PSR-7 Message implementation
                                                                                                                    nyholm-psr7
                                                                                                                    Nyholm PSR-7 Message implementation
                                                                                                                    guzzle-psr7
                                                                                                                    Guzzle PSR-7 Message implementation
                                                                                                                    zend-diactoros
                                                                                                                    Zend Diactoros PSR-7 Message implementation
                                                                                                                    		slim-psr7
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.camelCase

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-slim4

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    psr7ImplementationSlim 4 provides its own PSR-7 implementation so that it works out of the box. However, you are free to replace Slim’s default PSR-7 objects with a third-party implementation. Ref: https://www.slimframework.com/docs/v4/concepts/value-objects.html
                                                                                                                    slim-psr7
                                                                                                                    Slim PSR-7 Message implementation
                                                                                                                    nyholm-psr7
                                                                                                                    Nyholm PSR-7 Message implementation
                                                                                                                    guzzle-psr7
                                                                                                                    Guzzle PSR-7 Message implementation
                                                                                                                    zend-diactoros
                                                                                                                    Zend Diactoros PSR-7 Message implementation
                                                                                                                    		slim-psr7
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.camelCase

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-symfony/index.html b/docs/generators/php-symfony/index.html index ab68cf048fd..5e2a24140c2 100644 --- a/docs/generators/php-symfony/index.html +++ b/docs/generators/php-symfony/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-symfony

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    bundleAliasThe alias of the Symfony bundle. The template uses {{aliasName}}null
                                                                                                                    bundleNameThe name of the Symfony bundle. The template uses {{bundleName}}null
                                                                                                                    composerProjectNameThe project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-clientnull
                                                                                                                    composerVendorNameThe vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypetsnull
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    phpLegacySupportShould the generated code be compatible with PHP 5.x?true
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • array
                                                                                                                    • bool
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-symfony

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    bundleAliasThe alias of the Symfony bundle. The template uses {{aliasName}}null
                                                                                                                    bundleNameThe name of the Symfony bundle. The template uses {{bundleName}}null
                                                                                                                    composerProjectNameThe project name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. petstore-clientnull
                                                                                                                    composerVendorNameThe vendor name used in the composer package name. The template uses {{composerVendorName}}/{{composerProjectName}} for the composer package name. e.g. yaypetsnull
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    phpLegacySupportShould the generated code be compatible with PHP 5.x?true
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • array
                                                                                                                    • bool
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php-ze-ph/index.html b/docs/generators/php-ze-ph/index.html index fb5c438d4c1..f8209af6ae6 100644 --- a/docs/generators/php-ze-ph/index.html +++ b/docs/generators/php-ze-ph/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php-ze-ph

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php-ze-ph

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/php/index.html b/docs/generators/php/index.html index d77489dcc96..be871ea1e9c 100644 --- a/docs/generators/php/index.html +++ b/docs/generators/php/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for php

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    hideGenerationTimestampboolean, toggles whether unicode identifiers are allowed in names or not, default is falsetrue
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for php

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                    apiPackagepackage for generated api classesnull
                                                                                                                    artifactVersionThe version to use in the composer package version field. e.g. 1.2.3null
                                                                                                                    ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                    hideGenerationTimestampboolean, toggles whether unicode identifiers are allowed in names or not, default is falsetrue
                                                                                                                    invokerPackageThe main namespace to use for all classes. e.g. Yay\Petsnull
                                                                                                                    modelPackagepackage for generated modelsnull
                                                                                                                    packageNameThe main package name for classes. e.g. GeneratedPetstorenull
                                                                                                                    prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                    sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                    sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                    srcBasePathThe directory to serve as source root.null
                                                                                                                    variableNamingConventionnaming convention of variable name, e.g. camelCase.snake_case

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayarray
                                                                                                                    mapmap

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • DateTime
                                                                                                                    • bool
                                                                                                                    • boolean
                                                                                                                    • byte
                                                                                                                    • double
                                                                                                                    • float
                                                                                                                    • int
                                                                                                                    • integer
                                                                                                                    • mixed
                                                                                                                    • number
                                                                                                                    • object
                                                                                                                    • string
                                                                                                                    • void

                                                                                                                    RESERVED WORDS

                                                                                                                    • __halt_compiler
                                                                                                                    • _header_accept
                                                                                                                    • _tempbody
                                                                                                                    • abstract
                                                                                                                    • and
                                                                                                                    • array
                                                                                                                    • as
                                                                                                                    • break
                                                                                                                    • callable
                                                                                                                    • case
                                                                                                                    • catch
                                                                                                                    • class
                                                                                                                    • clone
                                                                                                                    • const
                                                                                                                    • continue
                                                                                                                    • declare
                                                                                                                    • default
                                                                                                                    • die
                                                                                                                    • do
                                                                                                                    • echo
                                                                                                                    • else
                                                                                                                    • elseif
                                                                                                                    • empty
                                                                                                                    • enddeclare
                                                                                                                    • endfor
                                                                                                                    • endforeach
                                                                                                                    • endif
                                                                                                                    • endswitch
                                                                                                                    • endwhile
                                                                                                                    • eval
                                                                                                                    • exit
                                                                                                                    • extends
                                                                                                                    • final
                                                                                                                    • for
                                                                                                                    • foreach
                                                                                                                    • formparams
                                                                                                                    • function
                                                                                                                    • global
                                                                                                                    • goto
                                                                                                                    • headerparams
                                                                                                                    • httpbody
                                                                                                                    • if
                                                                                                                    • implements
                                                                                                                    • include
                                                                                                                    • include_once
                                                                                                                    • instanceof
                                                                                                                    • insteadof
                                                                                                                    • interface
                                                                                                                    • isset
                                                                                                                    • list
                                                                                                                    • namespace
                                                                                                                    • new
                                                                                                                    • or
                                                                                                                    • print
                                                                                                                    • private
                                                                                                                    • protected
                                                                                                                    • public
                                                                                                                    • queryparams
                                                                                                                    • require
                                                                                                                    • require_once
                                                                                                                    • resourcepath
                                                                                                                    • return
                                                                                                                    • static
                                                                                                                    • switch
                                                                                                                    • throw
                                                                                                                    • trait
                                                                                                                    • try
                                                                                                                    • unset
                                                                                                                    • use
                                                                                                                    • var
                                                                                                                    • while
                                                                                                                    • xor

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✓OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✗OAS2,OAS3
                                                                                                                    ApiKey✗OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✗OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/powershell/index.html b/docs/generators/powershell/index.html index 011e2f116f0..1fd524fb43e 100644 --- a/docs/generators/powershell/index.html +++ b/docs/generators/powershell/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for powershell

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    csharpClientPathPath 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
                                                                                                                    packageGuidGUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.null
                                                                                                                    packageNameClient package name (e.g. org.openapitools.client).Org.OpenAPITools

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • Boolean
                                                                                                                    • Byte
                                                                                                                    • Byte[]
                                                                                                                    • Char
                                                                                                                    • Decimal
                                                                                                                    • Double
                                                                                                                    • Guid
                                                                                                                    • Int16
                                                                                                                    • Int32
                                                                                                                    • Int64
                                                                                                                    • ProgressRecord
                                                                                                                    • SByte
                                                                                                                    • SecureString
                                                                                                                    • Single
                                                                                                                    • String
                                                                                                                    • System.DateTime
                                                                                                                    • TimeSpan
                                                                                                                    • UInt16
                                                                                                                    • UInt32
                                                                                                                    • UInt64
                                                                                                                    • Uri
                                                                                                                    • Version
                                                                                                                    • XmlDocument

                                                                                                                    RESERVED WORDS

                                                                                                                    • Begin
                                                                                                                    • Break
                                                                                                                    • Catch
                                                                                                                    • Continue
                                                                                                                    • Data
                                                                                                                    • Do
                                                                                                                    • Dynamicparam
                                                                                                                    • Else
                                                                                                                    • Elseif
                                                                                                                    • End
                                                                                                                    • Exit
                                                                                                                    • Filter
                                                                                                                    • Finally
                                                                                                                    • For
                                                                                                                    • Foreach
                                                                                                                    • From
                                                                                                                    • Function
                                                                                                                    • If
                                                                                                                    • In
                                                                                                                    • Local
                                                                                                                    • Param
                                                                                                                    • Private
                                                                                                                    • Process
                                                                                                                    • Return
                                                                                                                    • Switch
                                                                                                                    • Throw
                                                                                                                    • Trap
                                                                                                                    • Try
                                                                                                                    • Until
                                                                                                                    • Where
                                                                                                                    • While

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✗OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    +

                                                                                                                    Config Options for powershell

                                                                                                                    OptionDescriptionValuesDefault
                                                                                                                    csharpClientPathPath 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
                                                                                                                    packageGuidGUID for PowerShell module (e.g. a27b908d-2a20-467f-bc32-af6f3a654ac5). A random GUID will be generated by default.null
                                                                                                                    packageNameClient package name (e.g. org.openapitools.client).Org.OpenAPITools

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports
                                                                                                                    Arrayjava.util.List
                                                                                                                    ArrayListjava.util.ArrayList
                                                                                                                    BigDecimaljava.math.BigDecimal
                                                                                                                    Datejava.util.Date
                                                                                                                    DateTimeorg.joda.time.*
                                                                                                                    Filejava.io.File
                                                                                                                    HashMapjava.util.HashMap
                                                                                                                    Listjava.util.*
                                                                                                                    LocalDateorg.joda.time.*
                                                                                                                    LocalDateTimeorg.joda.time.*
                                                                                                                    LocalTimeorg.joda.time.*
                                                                                                                    Mapjava.util.Map
                                                                                                                    Setjava.util.*
                                                                                                                    Timestampjava.sql.Timestamp
                                                                                                                    URIjava.net.URI
                                                                                                                    UUIDjava.util.UUID

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • Boolean
                                                                                                                    • Byte
                                                                                                                    • Byte[]
                                                                                                                    • Char
                                                                                                                    • Decimal
                                                                                                                    • Double
                                                                                                                    • Guid
                                                                                                                    • Int16
                                                                                                                    • Int32
                                                                                                                    • Int64
                                                                                                                    • ProgressRecord
                                                                                                                    • SByte
                                                                                                                    • SecureString
                                                                                                                    • Single
                                                                                                                    • String
                                                                                                                    • System.DateTime
                                                                                                                    • TimeSpan
                                                                                                                    • UInt16
                                                                                                                    • UInt32
                                                                                                                    • UInt64
                                                                                                                    • Uri
                                                                                                                    • Version
                                                                                                                    • XmlDocument

                                                                                                                    RESERVED WORDS

                                                                                                                    • Begin
                                                                                                                    • Break
                                                                                                                    • Catch
                                                                                                                    • Continue
                                                                                                                    • Data
                                                                                                                    • Do
                                                                                                                    • Dynamicparam
                                                                                                                    • Else
                                                                                                                    • Elseif
                                                                                                                    • End
                                                                                                                    • Exit
                                                                                                                    • Filter
                                                                                                                    • Finally
                                                                                                                    • For
                                                                                                                    • Foreach
                                                                                                                    • From
                                                                                                                    • Function
                                                                                                                    • If
                                                                                                                    • In
                                                                                                                    • Local
                                                                                                                    • Param
                                                                                                                    • Private
                                                                                                                    • Process
                                                                                                                    • Return
                                                                                                                    • Switch
                                                                                                                    • Throw
                                                                                                                    • Trap
                                                                                                                    • Try
                                                                                                                    • Until
                                                                                                                    • Where
                                                                                                                    • While

                                                                                                                    FEATURE SET

                                                                                                                    Client Modification Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasePath✗ToolingExtension
                                                                                                                    Authorizations✗ToolingExtension
                                                                                                                    UserAgent✗ToolingExtension

                                                                                                                    Data Type Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Int32✓OAS2,OAS3
                                                                                                                    Int64✓OAS2,OAS3
                                                                                                                    Float✓OAS2,OAS3
                                                                                                                    Double✓OAS2,OAS3
                                                                                                                    Decimal✓ToolingExtension
                                                                                                                    String✓OAS2,OAS3
                                                                                                                    Byte✓OAS2,OAS3
                                                                                                                    Binary✓OAS2,OAS3
                                                                                                                    Boolean✓OAS2,OAS3
                                                                                                                    Date✓OAS2,OAS3
                                                                                                                    DateTime✓OAS2,OAS3
                                                                                                                    Password✓OAS2,OAS3
                                                                                                                    File✓OAS2
                                                                                                                    Array✓OAS2,OAS3
                                                                                                                    Maps✓ToolingExtension
                                                                                                                    CollectionFormat✓OAS2
                                                                                                                    CollectionFormatMulti✓OAS2
                                                                                                                    Enum✓OAS2,OAS3
                                                                                                                    ArrayOfEnum✓ToolingExtension
                                                                                                                    ArrayOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                    ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                    MapOfEnum✓ToolingExtension
                                                                                                                    MapOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                    MapOfCollectionOfModel✓ToolingExtension
                                                                                                                    MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                    Documentation Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Readme✓ToolingExtension
                                                                                                                    Model✓ToolingExtension
                                                                                                                    Api✓ToolingExtension

                                                                                                                    Global Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Host✓OAS2,OAS3
                                                                                                                    BasePath✓OAS2,OAS3
                                                                                                                    Info✓OAS2,OAS3
                                                                                                                    Schemes✗OAS2,OAS3
                                                                                                                    PartialSchemes✓OAS2,OAS3
                                                                                                                    Consumes✓OAS2
                                                                                                                    Produces✓OAS2
                                                                                                                    ExternalDocumentation✓OAS2,OAS3
                                                                                                                    Examples✓OAS2,OAS3
                                                                                                                    XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                    MultiServer✗OAS3
                                                                                                                    ParameterizedServer✗OAS3
                                                                                                                    ParameterStyling✗OAS3
                                                                                                                    Callbacks✗OAS3
                                                                                                                    LinkObjects✗OAS3

                                                                                                                    Parameter Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Path✓OAS2,OAS3
                                                                                                                    Query✓OAS2,OAS3
                                                                                                                    Header✓OAS2,OAS3
                                                                                                                    Body✓OAS2
                                                                                                                    FormUnencoded✓OAS2
                                                                                                                    FormMultipart✓OAS2
                                                                                                                    Cookie✗OAS3

                                                                                                                    Schema Support Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    Simple✓OAS2,OAS3
                                                                                                                    Composite✓OAS2,OAS3
                                                                                                                    Polymorphism✗OAS2,OAS3
                                                                                                                    Union✗OAS3

                                                                                                                    Security Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    BasicAuth✓OAS2,OAS3
                                                                                                                    ApiKey✓OAS2,OAS3
                                                                                                                    OpenIDConnect✗OAS3
                                                                                                                    BearerToken✗OAS3
                                                                                                                    OAuth2_Implicit✓OAS2,OAS3
                                                                                                                    OAuth2_Password✗OAS2,OAS3
                                                                                                                    OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                    OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                    Wire Format Feature

                                                                                                                    NameSupportedDefined By
                                                                                                                    JSON✓OAS2,OAS3
                                                                                                                    XML✓OAS2,OAS3
                                                                                                                    PROTOBUF✗ToolingExtension
                                                                                                                    Custom✗OAS2,OAS3
                                                                                                                    Edit this page
                                                                                                                    Last updated on by Jim Schubert
                                                                                                                    - + - + - + diff --git a/docs/generators/protobuf-schema/index.html b/docs/generators/protobuf-schema/index.html index ec7dc6c5b0f..cda42efbbdd 100644 --- a/docs/generators/protobuf-schema/index.html +++ b/docs/generators/protobuf-schema/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                    -

                                                                                                                    Config Options for protobuf-schema

                                                                                                                    OptionDescriptionValuesDefault

                                                                                                                    IMPORT MAPPING

                                                                                                                    Type/AliasImports

                                                                                                                    INSTANTIATION TYPES

                                                                                                                    Type/AliasInstantiated By
                                                                                                                    arrayrepeat

                                                                                                                    LANGUAGE PRIMITIVES

                                                                                                                    • array
                                                                                                                    • bool
                                                                                                                    • bytes
                                                                                                                    • double
                                                                                                                    • fixed32
                                                                                                                    • fixed64
                                                                                                                    • float
                                                                                                                    • int32
                                                                                                                    • int64
                                                                                                                    • map
                                                                                                                    • sfixed32
                                                                                                                    • sfixed64
                                                                                                                    • sint32
                                                                                                                    • sint64
                                                                                                                    • string
                                                                                                                    • uint32
                                                                                                                    • uint64

                                                                                                                    RESERVED WORDS

                                                                                                                      FEATURE SET

                                                                                                                      Client Modification Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      BasePath✗ToolingExtension
                                                                                                                      Authorizations✗ToolingExtension
                                                                                                                      UserAgent✗ToolingExtension

                                                                                                                      Data Type Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      Custom✗OAS2,OAS3
                                                                                                                      Int32✓OAS2,OAS3
                                                                                                                      Int64✓OAS2,OAS3
                                                                                                                      Float✓OAS2,OAS3
                                                                                                                      Double✓OAS2,OAS3
                                                                                                                      Decimal✓ToolingExtension
                                                                                                                      String✓OAS2,OAS3
                                                                                                                      Byte✓OAS2,OAS3
                                                                                                                      Binary✓OAS2,OAS3
                                                                                                                      Boolean✓OAS2,OAS3
                                                                                                                      Date✓OAS2,OAS3
                                                                                                                      DateTime✓OAS2,OAS3
                                                                                                                      Password✓OAS2,OAS3
                                                                                                                      File✓OAS2
                                                                                                                      Array✓OAS2,OAS3
                                                                                                                      Maps✓ToolingExtension
                                                                                                                      CollectionFormat✓OAS2
                                                                                                                      CollectionFormatMulti✓OAS2
                                                                                                                      Enum✓OAS2,OAS3
                                                                                                                      ArrayOfEnum✓ToolingExtension
                                                                                                                      ArrayOfModel✓ToolingExtension
                                                                                                                      ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                      ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                      ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                      MapOfEnum✓ToolingExtension
                                                                                                                      MapOfModel✓ToolingExtension
                                                                                                                      MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                      MapOfCollectionOfModel✓ToolingExtension
                                                                                                                      MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                      Documentation Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      Readme✓ToolingExtension
                                                                                                                      Model✓ToolingExtension
                                                                                                                      Api✓ToolingExtension

                                                                                                                      Global Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      Host✓OAS2,OAS3
                                                                                                                      BasePath✓OAS2,OAS3
                                                                                                                      Info✓OAS2,OAS3
                                                                                                                      Schemes✗OAS2,OAS3
                                                                                                                      PartialSchemes✓OAS2,OAS3
                                                                                                                      Consumes✓OAS2
                                                                                                                      Produces✓OAS2
                                                                                                                      ExternalDocumentation✓OAS2,OAS3
                                                                                                                      Examples✓OAS2,OAS3
                                                                                                                      XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                      MultiServer✗OAS3
                                                                                                                      ParameterizedServer✗OAS3
                                                                                                                      ParameterStyling✗OAS3
                                                                                                                      Callbacks✓OAS3
                                                                                                                      LinkObjects✗OAS3

                                                                                                                      Parameter Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      Path✓OAS2,OAS3
                                                                                                                      Query✓OAS2,OAS3
                                                                                                                      Header✓OAS2,OAS3
                                                                                                                      Body✓OAS2
                                                                                                                      FormUnencoded✓OAS2
                                                                                                                      FormMultipart✓OAS2
                                                                                                                      Cookie✓OAS3

                                                                                                                      Schema Support Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      Simple✓OAS2,OAS3
                                                                                                                      Composite✓OAS2,OAS3
                                                                                                                      Polymorphism✓OAS2,OAS3
                                                                                                                      Union✗OAS3

                                                                                                                      Security Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      BasicAuth✗OAS2,OAS3
                                                                                                                      ApiKey✗OAS2,OAS3
                                                                                                                      OpenIDConnect✗OAS3
                                                                                                                      BearerToken✗OAS3
                                                                                                                      OAuth2_Implicit✗OAS2,OAS3
                                                                                                                      OAuth2_Password✗OAS2,OAS3
                                                                                                                      OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                      OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                      Wire Format Feature

                                                                                                                      NameSupportedDefined By
                                                                                                                      JSON✗OAS2,OAS3
                                                                                                                      XML✗OAS2,OAS3
                                                                                                                      PROTOBUF✓ToolingExtension
                                                                                                                      Custom✗OAS2,OAS3
                                                                                                                      Edit this page
                                                                                                                      Last updated on by Jim Schubert
                                                                                                                      +

                                                                                                                      Config Options for protobuf-schema

                                                                                                                      OptionDescriptionValuesDefault

                                                                                                                      IMPORT MAPPING

                                                                                                                      Type/AliasImports

                                                                                                                      INSTANTIATION TYPES

                                                                                                                      Type/AliasInstantiated By
                                                                                                                      arrayrepeat

                                                                                                                      LANGUAGE PRIMITIVES

                                                                                                                      • array
                                                                                                                      • bool
                                                                                                                      • bytes
                                                                                                                      • double
                                                                                                                      • fixed32
                                                                                                                      • fixed64
                                                                                                                      • float
                                                                                                                      • int32
                                                                                                                      • int64
                                                                                                                      • map
                                                                                                                      • sfixed32
                                                                                                                      • sfixed64
                                                                                                                      • sint32
                                                                                                                      • sint64
                                                                                                                      • string
                                                                                                                      • uint32
                                                                                                                      • uint64

                                                                                                                      RESERVED WORDS

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✓OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✗OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✓ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/python-aiohttp/index.html b/docs/generators/python-aiohttp/index.html index 59ed127851c..cdcb2281358 100644 --- a/docs/generators/python-aiohttp/index.html +++ b/docs/generators/python-aiohttp/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for python-aiohttp

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        controllerPackagecontroller packagecontrollers
                                                                                                                        defaultControllerdefault controllerdefault_controller
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_server
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        serverPortTCP port to listen to in app.run8080
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportPython2support python2false
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Dict
                                                                                                                        • List
                                                                                                                        • bool
                                                                                                                        • byte
                                                                                                                        • bytearray
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • raise
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for python-aiohttp

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        controllerPackagecontroller packagecontrollers
                                                                                                                        defaultControllerdefault controllerdefault_controller
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_server
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        serverPortTCP port to listen to in app.run8080
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportPython2support python2false
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Dict
                                                                                                                        • List
                                                                                                                        • bool
                                                                                                                        • byte
                                                                                                                        • bytearray
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • raise
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/python-blueplanet/index.html b/docs/generators/python-blueplanet/index.html index cedf4d0861c..e98e72cdfe3 100644 --- a/docs/generators/python-blueplanet/index.html +++ b/docs/generators/python-blueplanet/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for python-blueplanet

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        controllerPackagecontroller packagecontrollers
                                                                                                                        defaultControllerdefault controllerdefault_controller
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_server
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        serverPortTCP port to listen to in app.run8080
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportPython2support python2false
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Dict
                                                                                                                        • List
                                                                                                                        • bool
                                                                                                                        • byte
                                                                                                                        • bytearray
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • raise
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for python-blueplanet

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        controllerPackagecontroller packagecontrollers
                                                                                                                        defaultControllerdefault controllerdefault_controller
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_server
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        serverPortTCP port to listen to in app.run8080
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportPython2support python2false
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Dict
                                                                                                                        • List
                                                                                                                        • bool
                                                                                                                        • byte
                                                                                                                        • bytearray
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • raise
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/python-experimental/index.html b/docs/generators/python-experimental/index.html index 02b27805ba2..357a944bf71 100644 --- a/docs/generators/python-experimental/index.html +++ b/docs/generators/python-experimental/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for python-experimental

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        generateSourceCodeOnlySpecifies that only a library source code is to be generated.false
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        librarylibrary template (sub-template) to use: asyncio, tornado, urllib3urllib3
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_client
                                                                                                                        packageUrlpython package URL.null
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        projectNamepython project name in setup.py (e.g. petstore-api).null
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        mapdict

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • bool
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • dict
                                                                                                                        • file
                                                                                                                        • file_type
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • list
                                                                                                                        • none_type
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • all_params
                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • async
                                                                                                                        • auth_settings
                                                                                                                        • await
                                                                                                                        • body_params
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • form_params
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • header_params
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • local_var_files
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • path_params
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • query_params
                                                                                                                        • raise
                                                                                                                        • resource_path
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for python-experimental

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        generateSourceCodeOnlySpecifies that only a library source code is to be generated.false
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        librarylibrary template (sub-template) to use: asyncio, tornado, urllib3urllib3
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_client
                                                                                                                        packageUrlpython package URL.null
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        projectNamepython project name in setup.py (e.g. petstore-api).null
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        mapdict

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • bool
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • dict
                                                                                                                        • file
                                                                                                                        • file_type
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • list
                                                                                                                        • none_type
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • all_params
                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • async
                                                                                                                        • auth_settings
                                                                                                                        • await
                                                                                                                        • body_params
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • form_params
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • header_params
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • local_var_files
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • path_params
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • query_params
                                                                                                                        • raise
                                                                                                                        • resource_path
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/python-flask/index.html b/docs/generators/python-flask/index.html index 01761c63fed..d1757574942 100644 --- a/docs/generators/python-flask/index.html +++ b/docs/generators/python-flask/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for python-flask

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        controllerPackagecontroller packagecontrollers
                                                                                                                        defaultControllerdefault controllerdefault_controller
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_server
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        serverPortTCP port to listen to in app.run8080
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportPython2support python2false
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Dict
                                                                                                                        • List
                                                                                                                        • bool
                                                                                                                        • byte
                                                                                                                        • bytearray
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • raise
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✓OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for python-flask

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        controllerPackagecontroller packagecontrollers
                                                                                                                        defaultControllerdefault controllerdefault_controller
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_server
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        serverPortTCP port to listen to in app.run8080
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportPython2support python2false
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Dict
                                                                                                                        • List
                                                                                                                        • bool
                                                                                                                        • byte
                                                                                                                        • bytearray
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • raise
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✓OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/python/index.html b/docs/generators/python/index.html index f78a67b8453..5167b8e22c3 100644 --- a/docs/generators/python/index.html +++ b/docs/generators/python/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for python

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        generateSourceCodeOnlySpecifies that only a library source code is to be generated.false
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        librarylibrary template (sub-template) to use: asyncio, tornado, urllib3urllib3
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_client
                                                                                                                        packageUrlpython package URL.null
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        projectNamepython project name in setup.py (e.g. petstore-api).null
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • bool
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • dict
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • list
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • all_params
                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • async
                                                                                                                        • auth_settings
                                                                                                                        • await
                                                                                                                        • body_params
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • form_params
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • header_params
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • local_var_files
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • path_params
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • query_params
                                                                                                                        • raise
                                                                                                                        • resource_path
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for python

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        generateSourceCodeOnlySpecifies that only a library source code is to be generated.false
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        librarylibrary template (sub-template) to use: asyncio, tornado, urllib3urllib3
                                                                                                                        packageNamepython package name (convention: snake_case).openapi_client
                                                                                                                        packageUrlpython package URL.null
                                                                                                                        packageVersionpython package version.1.0.0
                                                                                                                        projectNamepython project name in setup.py (e.g. petstore-api).null
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        useNoseuse the nose test frameworkfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • bool
                                                                                                                        • date
                                                                                                                        • datetime
                                                                                                                        • dict
                                                                                                                        • file
                                                                                                                        • float
                                                                                                                        • int
                                                                                                                        • list
                                                                                                                        • object
                                                                                                                        • str

                                                                                                                        RESERVED WORDS

                                                                                                                        • all_params
                                                                                                                        • and
                                                                                                                        • as
                                                                                                                        • assert
                                                                                                                        • async
                                                                                                                        • auth_settings
                                                                                                                        • await
                                                                                                                        • body_params
                                                                                                                        • break
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • del
                                                                                                                        • elif
                                                                                                                        • else
                                                                                                                        • except
                                                                                                                        • exec
                                                                                                                        • false
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • form_params
                                                                                                                        • from
                                                                                                                        • global
                                                                                                                        • header_params
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • is
                                                                                                                        • lambda
                                                                                                                        • local_var_files
                                                                                                                        • none
                                                                                                                        • nonlocal
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • pass
                                                                                                                        • path_params
                                                                                                                        • print
                                                                                                                        • property
                                                                                                                        • query_params
                                                                                                                        • raise
                                                                                                                        • resource_path
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/r/index.html b/docs/generators/r/index.html index 00bcbfa7235..c67f0a5af59 100644 --- a/docs/generators/r/index.html +++ b/docs/generators/r/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for r

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        exceptionPackageSpecify the exception handling package
                                                                                                                        default
                                                                                                                        Use stop() for raising exceptions.
                                                                                                                        rlang
                                                                                                                        Use rlang package for exceptions.
                                                                                                                        		default
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        packageNameR package name (convention: lowercase).openapi
                                                                                                                        packageVersionR package version.1.0.0
                                                                                                                        returnExceptionOnFailureThrow an exception on non success response codesfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • character
                                                                                                                        • data.frame
                                                                                                                        • integer
                                                                                                                        • numeric
                                                                                                                        • object

                                                                                                                        RESERVED WORDS

                                                                                                                        • apiresponse
                                                                                                                        • break
                                                                                                                        • else
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • function
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • inf
                                                                                                                        • na
                                                                                                                        • na_character_
                                                                                                                        • na_complex_
                                                                                                                        • na_integer_
                                                                                                                        • na_real_
                                                                                                                        • nan
                                                                                                                        • next
                                                                                                                        • null
                                                                                                                        • repeat
                                                                                                                        • true
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for r

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        exceptionPackageSpecify the exception handling package
                                                                                                                        default
                                                                                                                        Use stop() for raising exceptions.
                                                                                                                        rlang
                                                                                                                        Use rlang package for exceptions.
                                                                                                                        		default
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        packageNameR package name (convention: lowercase).openapi
                                                                                                                        packageVersionR package version.1.0.0
                                                                                                                        returnExceptionOnFailureThrow an exception on non success response codesfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • character
                                                                                                                        • data.frame
                                                                                                                        • integer
                                                                                                                        • numeric
                                                                                                                        • object

                                                                                                                        RESERVED WORDS

                                                                                                                        • apiresponse
                                                                                                                        • break
                                                                                                                        • else
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • function
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • inf
                                                                                                                        • na
                                                                                                                        • na_character_
                                                                                                                        • na_complex_
                                                                                                                        • na_integer_
                                                                                                                        • na_real_
                                                                                                                        • nan
                                                                                                                        • next
                                                                                                                        • null
                                                                                                                        • repeat
                                                                                                                        • true
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/ruby-on-rails/index.html b/docs/generators/ruby-on-rails/index.html index f0fff878ff3..cedfb6ad8d9 100644 --- a/docs/generators/ruby-on-rails/index.html +++ b/docs/generators/ruby-on-rails/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for ruby-on-rails

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        databaseAdapterThe adapter for database (e.g. mysql, sqlite). Default: sqlitesqlite

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • DateTime
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Hash
                                                                                                                        • Integer
                                                                                                                        • Object
                                                                                                                        • String

                                                                                                                        RESERVED WORDS

                                                                                                                        • __file__
                                                                                                                        • __line__
                                                                                                                        • alias
                                                                                                                        • and
                                                                                                                        • begin
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • defined?
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • elsif
                                                                                                                        • end
                                                                                                                        • ensure
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • module
                                                                                                                        • next
                                                                                                                        • nil
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • redo
                                                                                                                        • rescue
                                                                                                                        • retry
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • super
                                                                                                                        • then
                                                                                                                        • true
                                                                                                                        • undef
                                                                                                                        • unless
                                                                                                                        • until
                                                                                                                        • when
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for ruby-on-rails

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        databaseAdapterThe adapter for database (e.g. mysql, sqlite). Default: sqlitesqlite

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • DateTime
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Hash
                                                                                                                        • Integer
                                                                                                                        • Object
                                                                                                                        • String

                                                                                                                        RESERVED WORDS

                                                                                                                        • __file__
                                                                                                                        • __line__
                                                                                                                        • alias
                                                                                                                        • and
                                                                                                                        • begin
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • defined?
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • elsif
                                                                                                                        • end
                                                                                                                        • ensure
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • module
                                                                                                                        • next
                                                                                                                        • nil
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • redo
                                                                                                                        • rescue
                                                                                                                        • retry
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • super
                                                                                                                        • then
                                                                                                                        • true
                                                                                                                        • undef
                                                                                                                        • unless
                                                                                                                        • until
                                                                                                                        • when
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/ruby-sinatra/index.html b/docs/generators/ruby-sinatra/index.html index 0488b54403c..0094b5451ef 100644 --- a/docs/generators/ruby-sinatra/index.html +++ b/docs/generators/ruby-sinatra/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for ruby-sinatra

                                                                                                                        OptionDescriptionValuesDefault

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • DateTime
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Hash
                                                                                                                        • Integer
                                                                                                                        • Object
                                                                                                                        • String

                                                                                                                        RESERVED WORDS

                                                                                                                        • __file__
                                                                                                                        • __line__
                                                                                                                        • alias
                                                                                                                        • and
                                                                                                                        • begin
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • defined?
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • elsif
                                                                                                                        • end
                                                                                                                        • ensure
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • module
                                                                                                                        • next
                                                                                                                        • nil
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • redo
                                                                                                                        • rescue
                                                                                                                        • retry
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • super
                                                                                                                        • then
                                                                                                                        • true
                                                                                                                        • undef
                                                                                                                        • unless
                                                                                                                        • until
                                                                                                                        • when
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for ruby-sinatra

                                                                                                                        OptionDescriptionValuesDefault

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • DateTime
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Hash
                                                                                                                        • Integer
                                                                                                                        • Object
                                                                                                                        • String

                                                                                                                        RESERVED WORDS

                                                                                                                        • __file__
                                                                                                                        • __line__
                                                                                                                        • alias
                                                                                                                        • and
                                                                                                                        • begin
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • defined?
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • elsif
                                                                                                                        • end
                                                                                                                        • ensure
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • module
                                                                                                                        • next
                                                                                                                        • nil
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • redo
                                                                                                                        • rescue
                                                                                                                        • retry
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • super
                                                                                                                        • then
                                                                                                                        • true
                                                                                                                        • undef
                                                                                                                        • unless
                                                                                                                        • until
                                                                                                                        • when
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/ruby/index.html b/docs/generators/ruby/index.html index 547cbbc5728..2e23afc4512 100644 --- a/docs/generators/ruby/index.html +++ b/docs/generators/ruby/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for ruby

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        gemAuthorgem author (only one is supported).null
                                                                                                                        gemAuthorEmailgem author email (only one is supported).null
                                                                                                                        gemDescriptiongem description.This gem maps to a REST API
                                                                                                                        gemHomepagegem homepage.http://org.openapitools
                                                                                                                        gemLicensegem license.unlicense
                                                                                                                        gemNamegem name (convention: underscore_case).openapi_client
                                                                                                                        gemRequiredRubyVersiongem required Ruby version.>= 1.9
                                                                                                                        gemSummarygem summary.A ruby wrapper for the REST APIs
                                                                                                                        gemVersiongem version.1.0.0
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        libraryHTTP library template (sub-template) to use
                                                                                                                        faraday
                                                                                                                        Faraday (https://github.com/lostisland/faraday) (Beta support)
                                                                                                                        typhoeus
                                                                                                                        Typhoeus >= 1.0.1 (https://github.com/typhoeus/typhoeus)
                                                                                                                        		typhoeus
                                                                                                                        moduleNametop module name (convention: CamelCase, usually corresponding to gem name).OpenAPIClient
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • DateTime
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Hash
                                                                                                                        • Integer
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • array
                                                                                                                        • int
                                                                                                                        • map
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • __file__
                                                                                                                        • __line__
                                                                                                                        • _header_accept
                                                                                                                        • _header_accept_result
                                                                                                                        • _header_content_type
                                                                                                                        • alias
                                                                                                                        • and
                                                                                                                        • auth_names
                                                                                                                        • begin
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • defined?
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • elsif
                                                                                                                        • end
                                                                                                                        • ensure
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • form_params
                                                                                                                        • header_params
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • local_var_path
                                                                                                                        • module
                                                                                                                        • next
                                                                                                                        • nil
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • post_body
                                                                                                                        • query_params
                                                                                                                        • redo
                                                                                                                        • rescue
                                                                                                                        • retry
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • send
                                                                                                                        • super
                                                                                                                        • then
                                                                                                                        • true
                                                                                                                        • undef
                                                                                                                        • unless
                                                                                                                        • until
                                                                                                                        • when
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for ruby

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        gemAuthorgem author (only one is supported).null
                                                                                                                        gemAuthorEmailgem author email (only one is supported).null
                                                                                                                        gemDescriptiongem description.This gem maps to a REST API
                                                                                                                        gemHomepagegem homepage.http://org.openapitools
                                                                                                                        gemLicensegem license.unlicense
                                                                                                                        gemNamegem name (convention: underscore_case).openapi_client
                                                                                                                        gemRequiredRubyVersiongem required Ruby version.>= 1.9
                                                                                                                        gemSummarygem summary.A ruby wrapper for the REST APIs
                                                                                                                        gemVersiongem version.1.0.0
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        libraryHTTP library template (sub-template) to use
                                                                                                                        faraday
                                                                                                                        Faraday (https://github.com/lostisland/faraday) (Beta support)
                                                                                                                        typhoeus
                                                                                                                        Typhoeus >= 1.0.1 (https://github.com/typhoeus/typhoeus)
                                                                                                                        		typhoeus
                                                                                                                        moduleNametop module name (convention: CamelCase, usually corresponding to gem name).OpenAPIClient
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • DateTime
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Hash
                                                                                                                        • Integer
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • array
                                                                                                                        • int
                                                                                                                        • map
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • __file__
                                                                                                                        • __line__
                                                                                                                        • _header_accept
                                                                                                                        • _header_accept_result
                                                                                                                        • _header_content_type
                                                                                                                        • alias
                                                                                                                        • and
                                                                                                                        • auth_names
                                                                                                                        • begin
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • defined?
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • elsif
                                                                                                                        • end
                                                                                                                        • ensure
                                                                                                                        • false
                                                                                                                        • for
                                                                                                                        • form_params
                                                                                                                        • header_params
                                                                                                                        • if
                                                                                                                        • in
                                                                                                                        • local_var_path
                                                                                                                        • module
                                                                                                                        • next
                                                                                                                        • nil
                                                                                                                        • not
                                                                                                                        • or
                                                                                                                        • post_body
                                                                                                                        • query_params
                                                                                                                        • redo
                                                                                                                        • rescue
                                                                                                                        • retry
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • send
                                                                                                                        • super
                                                                                                                        • then
                                                                                                                        • true
                                                                                                                        • undef
                                                                                                                        • unless
                                                                                                                        • until
                                                                                                                        • when
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/rust-server/index.html b/docs/generators/rust-server/index.html index b93ef2b97f1..674dfff154d 100644 --- a/docs/generators/rust-server/index.html +++ b/docs/generators/rust-server/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for rust-server

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        packageNameRust crate name (convention: snake_case).openapi_client
                                                                                                                        packageVersionRust crate version.null

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayVec
                                                                                                                        mapMap

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • String
                                                                                                                        • bool
                                                                                                                        • char
                                                                                                                        • f32
                                                                                                                        • f64
                                                                                                                        • i16
                                                                                                                        • i32
                                                                                                                        • i64
                                                                                                                        • i8
                                                                                                                        • isize
                                                                                                                        • str
                                                                                                                        • u16
                                                                                                                        • u32
                                                                                                                        • u64
                                                                                                                        • u8
                                                                                                                        • usize

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • alignof
                                                                                                                        • as
                                                                                                                        • become
                                                                                                                        • box
                                                                                                                        • break
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • crate
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extern
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • fn
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • impl
                                                                                                                        • in
                                                                                                                        • let
                                                                                                                        • loop
                                                                                                                        • macro
                                                                                                                        • match
                                                                                                                        • mod
                                                                                                                        • move
                                                                                                                        • mut
                                                                                                                        • offsetof
                                                                                                                        • override
                                                                                                                        • priv
                                                                                                                        • proc
                                                                                                                        • pub
                                                                                                                        • pure
                                                                                                                        • ref
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • sizeof
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • super
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • type
                                                                                                                        • typeof
                                                                                                                        • unsafe
                                                                                                                        • unsized
                                                                                                                        • use
                                                                                                                        • virtual
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✗OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for rust-server

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        packageNameRust crate name (convention: snake_case).openapi_client
                                                                                                                        packageVersionRust crate version.null

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayVec
                                                                                                                        mapMap

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • String
                                                                                                                        • bool
                                                                                                                        • char
                                                                                                                        • f32
                                                                                                                        • f64
                                                                                                                        • i16
                                                                                                                        • i32
                                                                                                                        • i64
                                                                                                                        • i8
                                                                                                                        • isize
                                                                                                                        • str
                                                                                                                        • u16
                                                                                                                        • u32
                                                                                                                        • u64
                                                                                                                        • u8
                                                                                                                        • usize

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • alignof
                                                                                                                        • as
                                                                                                                        • become
                                                                                                                        • box
                                                                                                                        • break
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • crate
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extern
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • fn
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • impl
                                                                                                                        • in
                                                                                                                        • let
                                                                                                                        • loop
                                                                                                                        • macro
                                                                                                                        • match
                                                                                                                        • mod
                                                                                                                        • move
                                                                                                                        • mut
                                                                                                                        • offsetof
                                                                                                                        • override
                                                                                                                        • priv
                                                                                                                        • proc
                                                                                                                        • pub
                                                                                                                        • pure
                                                                                                                        • ref
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • sizeof
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • super
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • type
                                                                                                                        • typeof
                                                                                                                        • unsafe
                                                                                                                        • unsized
                                                                                                                        • use
                                                                                                                        • virtual
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✗OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/rust/index.html b/docs/generators/rust/index.html index da59bcf486a..8743933ee4b 100644 --- a/docs/generators/rust/index.html +++ b/docs/generators/rust/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for rust

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        librarylibrary template (sub-template) to use.
                                                                                                                        hyper
                                                                                                                        HTTP client: Hyper.
                                                                                                                        reqwest
                                                                                                                        HTTP client: Reqwest.
                                                                                                                        		hyper
                                                                                                                        packageNameRust package name (convention: lowercase).openapi
                                                                                                                        packageVersionRust package version.1.0.0

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • File
                                                                                                                        • String
                                                                                                                        • Vec<u8>
                                                                                                                        • bool
                                                                                                                        • char
                                                                                                                        • f32
                                                                                                                        • f64
                                                                                                                        • i16
                                                                                                                        • i32
                                                                                                                        • i64
                                                                                                                        • i8
                                                                                                                        • u16
                                                                                                                        • u32
                                                                                                                        • u64
                                                                                                                        • u8

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • alignof
                                                                                                                        • as
                                                                                                                        • async
                                                                                                                        • await
                                                                                                                        • become
                                                                                                                        • box
                                                                                                                        • break
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • crate
                                                                                                                        • do
                                                                                                                        • dyn
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extern
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • fn
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • impl
                                                                                                                        • in
                                                                                                                        • let
                                                                                                                        • loop
                                                                                                                        • macro
                                                                                                                        • match
                                                                                                                        • mod
                                                                                                                        • move
                                                                                                                        • mut
                                                                                                                        • offsetof
                                                                                                                        • override
                                                                                                                        • priv
                                                                                                                        • proc
                                                                                                                        • pub
                                                                                                                        • pure
                                                                                                                        • ref
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • sizeof
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • super
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • typeof
                                                                                                                        • unsafe
                                                                                                                        • unsized
                                                                                                                        • use
                                                                                                                        • virtual
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +

                                                                                                                        Config Options for rust

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        librarylibrary template (sub-template) to use.
                                                                                                                        hyper
                                                                                                                        HTTP client: Hyper.
                                                                                                                        reqwest
                                                                                                                        HTTP client: Reqwest.
                                                                                                                        		hyper
                                                                                                                        packageNameRust package name (convention: lowercase).openapi
                                                                                                                        packageVersionRust package version.1.0.0

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • File
                                                                                                                        • String
                                                                                                                        • Vec<u8>
                                                                                                                        • bool
                                                                                                                        • char
                                                                                                                        • f32
                                                                                                                        • f64
                                                                                                                        • i16
                                                                                                                        • i32
                                                                                                                        • i64
                                                                                                                        • i8
                                                                                                                        • u16
                                                                                                                        • u32
                                                                                                                        • u64
                                                                                                                        • u8

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • alignof
                                                                                                                        • as
                                                                                                                        • async
                                                                                                                        • await
                                                                                                                        • become
                                                                                                                        • box
                                                                                                                        • break
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • crate
                                                                                                                        • do
                                                                                                                        • dyn
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extern
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • fn
                                                                                                                        • for
                                                                                                                        • if
                                                                                                                        • impl
                                                                                                                        • in
                                                                                                                        • let
                                                                                                                        • loop
                                                                                                                        • macro
                                                                                                                        • match
                                                                                                                        • mod
                                                                                                                        • move
                                                                                                                        • mut
                                                                                                                        • offsetof
                                                                                                                        • override
                                                                                                                        • priv
                                                                                                                        • proc
                                                                                                                        • pub
                                                                                                                        • pure
                                                                                                                        • ref
                                                                                                                        • return
                                                                                                                        • self
                                                                                                                        • sizeof
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • super
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • typeof
                                                                                                                        • unsafe
                                                                                                                        • unsized
                                                                                                                        • use
                                                                                                                        • virtual
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        - + - + - + diff --git a/docs/generators/scala-akka/index.html b/docs/generators/scala-akka/index.html index d1d153c7e1e..b92b7ad3519 100644 --- a/docs/generators/scala-akka/index.html +++ b/docs/generators/scala-akka/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scala-akka

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        mainPackageTop-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'org.openapitools.client
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • forsome
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scala-akka

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        mainPackageTop-level package name, which defines 'apiPackage', 'modelPackage', 'invokerPackage'org.openapitools.client
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • forsome
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✓ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scala-finch/index.html b/docs/generators/scala-finch/index.html index 095977efea1..83699e1ee5d 100644 --- a/docs/generators/scala-finch/index.html +++ b/docs/generators/scala-finch/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scala-finch

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        packageNameFinch package name (e.g. org.openapitools).org.openapitools

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        ArrayBufferscala.collection.mutable.ArrayBuffer
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimejava.time.LocalDateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapscala.collection.immutable.HashMap
                                                                                                                        LocalDatejava.time.LocalDate
                                                                                                                        LocalDateTimejava.time.LocalDateTime
                                                                                                                        LocalTimejava.time.LocalTime
                                                                                                                        Mapscala.collection.immutable.Map
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID
                                                                                                                        ZonedDateTimejava.time.ZonedDateTime

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArrayList
                                                                                                                        mapHashMap

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyRef
                                                                                                                        • AnyVal
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Object
                                                                                                                        • String

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • default
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • forsome
                                                                                                                        • goto
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • lazy
                                                                                                                        • long
                                                                                                                        • match
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • strictfp
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • trait
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scala-finch

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        packageNameFinch package name (e.g. org.openapitools).org.openapitools

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        ArrayBufferscala.collection.mutable.ArrayBuffer
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimejava.time.LocalDateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapscala.collection.immutable.HashMap
                                                                                                                        LocalDatejava.time.LocalDate
                                                                                                                        LocalDateTimejava.time.LocalDateTime
                                                                                                                        LocalTimejava.time.LocalTime
                                                                                                                        Mapscala.collection.immutable.Map
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID
                                                                                                                        ZonedDateTimejava.time.ZonedDateTime

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArrayList
                                                                                                                        mapHashMap

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyRef
                                                                                                                        • AnyVal
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Object
                                                                                                                        • String

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • assert
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • def
                                                                                                                        • default
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • forsome
                                                                                                                        • goto
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • lazy
                                                                                                                        • long
                                                                                                                        • match
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • strictfp
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • trait
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scala-gatling/index.html b/docs/generators/scala-gatling/index.html index edfa20e4388..25f46c8106c 100644 --- a/docs/generators/scala-gatling/index.html +++ b/docs/generators/scala-gatling/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scala-gatling

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scala-gatling

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scala-httpclient-deprecated/index.html b/docs/generators/scala-httpclient-deprecated/index.html index 6a8a4bc6513..df53325be43 100644 --- a/docs/generators/scala-httpclient-deprecated/index.html +++ b/docs/generators/scala-httpclient-deprecated/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scala-httpclient-deprecated

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scala-httpclient-deprecated

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scala-lagom-server/index.html b/docs/generators/scala-lagom-server/index.html index d73e0fb4ec8..704fe073fa7 100644 --- a/docs/generators/scala-lagom-server/index.html +++ b/docs/generators/scala-lagom-server/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scala-lagom-server

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scala-lagom-server

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scala-play-server/index.html b/docs/generators/scala-play-server/index.html index 3e5ed4a239b..cf5ef1b6ee3 100644 --- a/docs/generators/scala-play-server/index.html +++ b/docs/generators/scala-play-server/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scala-play-server

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        basePackageBase package in which supporting classes are generated.org.openapitools
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        generateCustomExceptionsIf set, generates custom exception types.true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        routesFileNameName of the routes file to generate.routes
                                                                                                                        skipStubsIf set, skips generation of stub classes.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull
                                                                                                                        supportAsyncIf set, wraps API return types with Futures and generates async actions.false
                                                                                                                        useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDatejava.time.LocalDate
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        OffsetDateTimejava.time.OffsetDateTime
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Setscala.collection.immutable.Set
                                                                                                                        TemporaryFileplay.api.libs.Files.TemporaryFile
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayList
                                                                                                                        mapMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • forSome
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scala-play-server

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        basePackageBase package in which supporting classes are generated.org.openapitools
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        generateCustomExceptionsIf set, generates custom exception types.true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        routesFileNameName of the routes file to generate.routes
                                                                                                                        skipStubsIf set, skips generation of stub classes.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull
                                                                                                                        supportAsyncIf set, wraps API return types with Futures and generates async actions.false
                                                                                                                        useSwaggerUIAdd a route to /api which show your documentation in swagger-ui. Will also import needed dependenciestrue

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDatejava.time.LocalDate
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        OffsetDateTimejava.time.OffsetDateTime
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Setscala.collection.immutable.Set
                                                                                                                        TemporaryFileplay.api.libs.Files.TemporaryFile
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayList
                                                                                                                        mapMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • forSome
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scalatra/index.html b/docs/generators/scalatra/index.html index 90beb633da8..4813fa49f69 100644 --- a/docs/generators/scalatra/index.html +++ b/docs/generators/scalatra/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scalatra

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.LocalDate
                                                                                                                        LocalDateTimeorg.joda.time.LocalDateTime
                                                                                                                        LocalTimeorg.joda.time.LocalTime
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setscala.collection.immutable.Set
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • assert
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • default
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extends
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • goto
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • strictfp
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • transient
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scalatra

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.LocalDate
                                                                                                                        LocalDateTimeorg.joda.time.LocalDateTime
                                                                                                                        LocalTimeorg.joda.time.LocalTime
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setscala.collection.immutable.Set
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • assert
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • default
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extends
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • goto
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • strictfp
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • transient
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/scalaz/index.html b/docs/generators/scalaz/index.html index 168916620af..7e4235ba8b3 100644 --- a/docs/generators/scalaz/index.html +++ b/docs/generators/scalaz/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for scalaz

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.LocalDate
                                                                                                                        LocalDateTimeorg.joda.time.LocalDateTime
                                                                                                                        LocalTimeorg.joda.time.LocalTime
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for scalaz

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiPackagepackage for generated api classesnull
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        modelPackagepackage for generated modelsnull
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codenull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.DateTime
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        ListBufferscala.collection.mutable.ListBuffer
                                                                                                                        ListSetscala.collection.immutable.ListSet
                                                                                                                        LocalDateorg.joda.time.LocalDate
                                                                                                                        LocalDateTimeorg.joda.time.LocalDateTime
                                                                                                                        LocalTimeorg.joda.time.LocalTime
                                                                                                                        Seqscala.collection.immutable.Seq
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayListBuffer
                                                                                                                        mapHashMap
                                                                                                                        setSet

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • List
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • Seq
                                                                                                                        • String
                                                                                                                        • boolean

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiinvoker
                                                                                                                        • basepath
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • contenttype
                                                                                                                        • contenttypes
                                                                                                                        • def
                                                                                                                        • do
                                                                                                                        • else
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • for
                                                                                                                        • formparams
                                                                                                                        • forsome
                                                                                                                        • headerparams
                                                                                                                        • if
                                                                                                                        • implicit
                                                                                                                        • import
                                                                                                                        • lazy
                                                                                                                        • match
                                                                                                                        • mp
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • override
                                                                                                                        • package
                                                                                                                        • path
                                                                                                                        • postbody
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • queryparams
                                                                                                                        • return
                                                                                                                        • sealed
                                                                                                                        • super
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • trait
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • type
                                                                                                                        • val
                                                                                                                        • var
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/spring/index.html b/docs/generators/spring/index.html index ac34121e7fd..35aa2f94425 100644 --- a/docs/generators/spring/index.html +++ b/docs/generators/spring/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for spring

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiFirstGenerate the API from the OAI spec at server compile time (API first approach)false
                                                                                                                        apiPackagepackage for generated api classesorg.openapitools.api
                                                                                                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-spring
                                                                                                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                                                        asyncuse async Callable controllersfalse
                                                                                                                        basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                                                                                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                                                        booleanGetterPrefixSet booleanGetterPrefixget
                                                                                                                        configPackageconfiguration package for generated codeorg.openapitools.configuration
                                                                                                                        dateLibraryOption. 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)
                                                                                                                        		threetenbp
                                                                                                                        delegatePatternWhether to generate the server files using the delegate patternfalse
                                                                                                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                                                        hateoasUse Spring HATEOAS library to allow adding HATEOAS linksfalse
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                                                                                                        interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                                                        invokerPackageroot package for generated codeorg.openapitools.api
                                                                                                                        java8Option. Use Java8 classes instead of third party equivalents
                                                                                                                        true
                                                                                                                        Use Java 8 classes such as Base64. Use java8 default interface when a responseWrapper is used
                                                                                                                        false
                                                                                                                        Various third party libraries as needed
                                                                                                                        		false
                                                                                                                        librarylibrary template (sub-template)
                                                                                                                        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
                                                                                                                        licenseNameThe name of the licenseUnlicense
                                                                                                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                                                        modelPackagepackage for generated modelsorg.openapitools.model
                                                                                                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                                                        performBeanValidationUse Bean Validation Impl. to perform BeanValidationfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        reactivewrap responses in Mono/Flux Reactor types (spring-boot only)false
                                                                                                                        responseWrapperwrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, HystrixCommand, RxObservable, RxSingle or fully qualified type)null
                                                                                                                        returnSuccessCodeGenerated server returns 2xx codefalse
                                                                                                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                                                        singleContentTypesWhether to select only one produces/consumes content-type by operation.false
                                                                                                                        skipDefaultInterfaceWhether to generate default implementations for java8 interfacesfalse
                                                                                                                        snapshotVersionUses a SNAPSHOT version.
                                                                                                                        true
                                                                                                                        Use a SnapShot Version
                                                                                                                        false
                                                                                                                        Use a Release Version
                                                                                                                        		null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codesrc/main/java
                                                                                                                        swaggerDocketConfigGenerate Spring OpenAPI Docket configuration class.false
                                                                                                                        titleserver title name or client service nameOpenAPI Spring
                                                                                                                        unhandledExceptionDeclare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives).false
                                                                                                                        useBeanValidationUse BeanValidation API annotationstrue
                                                                                                                        useOptionalUse Optional container for optional parametersfalse
                                                                                                                        useTagsuse tags for creating interface and controller classnamesfalse
                                                                                                                        virtualServiceGenerates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wikifalse
                                                                                                                        withXmlwhether 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

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArrayList
                                                                                                                        mapHashMap

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • boolean
                                                                                                                        • byte[]

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiclient
                                                                                                                        • apiexception
                                                                                                                        • apiresponse
                                                                                                                        • assert
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • configuration
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • default
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extends
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • goto
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • localreturntype
                                                                                                                        • localvaraccept
                                                                                                                        • localvaraccepts
                                                                                                                        • localvarauthnames
                                                                                                                        • localvarcollectionqueryparams
                                                                                                                        • localvarcontenttype
                                                                                                                        • localvarcontenttypes
                                                                                                                        • localvarcookieparams
                                                                                                                        • localvarformparams
                                                                                                                        • localvarheaderparams
                                                                                                                        • localvarpath
                                                                                                                        • localvarpostbody
                                                                                                                        • localvarqueryparams
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • strictfp
                                                                                                                        • stringutil
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • transient
                                                                                                                        • try
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✓OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for spring

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        additionalModelTypeAnnotationsAdditional annotations for model type(class level annotations)null
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiFirstGenerate the API from the OAI spec at server compile time (API first approach)false
                                                                                                                        apiPackagepackage for generated api classesorg.openapitools.api
                                                                                                                        artifactDescriptionartifact description in generated pom.xmlOpenAPI Java
                                                                                                                        artifactIdartifactId in generated pom.xml. This also becomes part of the generated library's filenameopenapi-spring
                                                                                                                        artifactUrlartifact URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                                                        artifactVersionartifact version in generated pom.xml. This also becomes part of the generated library's filename1.0.0
                                                                                                                        asyncuse async Callable controllersfalse
                                                                                                                        basePackagebase package (invokerPackage) for generated codeorg.openapitools
                                                                                                                        bigDecimalAsStringTreat BigDecimal values as Strings to avoid precision loss.false
                                                                                                                        booleanGetterPrefixSet booleanGetterPrefixget
                                                                                                                        configPackageconfiguration package for generated codeorg.openapitools.configuration
                                                                                                                        dateLibraryOption. 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)
                                                                                                                        		threetenbp
                                                                                                                        delegatePatternWhether to generate the server files using the delegate patternfalse
                                                                                                                        developerEmaildeveloper email in generated pom.xmlteam@openapitools.org
                                                                                                                        developerNamedeveloper name in generated pom.xmlOpenAPI-Generator Contributors
                                                                                                                        developerOrganizationdeveloper organization in generated pom.xmlOpenAPITools.org
                                                                                                                        developerOrganizationUrldeveloper organization URL in generated pom.xmlhttp://openapitools.org
                                                                                                                        disableHtmlEscapingDisable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)false
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        fullJavaUtilwhether to use fully qualified name for classes under java.util. This option only works for Java API clientfalse
                                                                                                                        groupIdgroupId in generated pom.xmlorg.openapitools
                                                                                                                        hateoasUse Spring HATEOAS library to allow adding HATEOAS linksfalse
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.false
                                                                                                                        implicitHeadersSkip header parameters in the generated API methods using @ApiImplicitParams annotation.false
                                                                                                                        interfaceOnlyWhether to generate only API interface stubs without the server files.false
                                                                                                                        invokerPackageroot package for generated codeorg.openapitools.api
                                                                                                                        java8Option. Use Java8 classes instead of third party equivalents
                                                                                                                        true
                                                                                                                        Use Java 8 classes such as Base64. Use java8 default interface when a responseWrapper is used
                                                                                                                        false
                                                                                                                        Various third party libraries as needed
                                                                                                                        		false
                                                                                                                        librarylibrary template (sub-template)
                                                                                                                        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
                                                                                                                        licenseNameThe name of the licenseUnlicense
                                                                                                                        licenseUrlThe URL of the licensehttp://unlicense.org
                                                                                                                        modelPackagepackage for generated modelsorg.openapitools.model
                                                                                                                        parentArtifactIdparent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                                                        parentGroupIdparent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                                                        parentVersionparent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effectnull
                                                                                                                        performBeanValidationUse Bean Validation Impl. to perform BeanValidationfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        reactivewrap responses in Mono/Flux Reactor types (spring-boot only)false
                                                                                                                        responseWrapperwrap the responses in given type (Future, Callable, CompletableFuture,ListenableFuture, DeferredResult, HystrixCommand, RxObservable, RxSingle or fully qualified type)null
                                                                                                                        returnSuccessCodeGenerated server returns 2xx codefalse
                                                                                                                        scmConnectionSCM connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                                                        scmDeveloperConnectionSCM developer connection in generated pom.xmlscm:git:git@github.com:openapitools/openapi-generator.git
                                                                                                                        scmUrlSCM URL in generated pom.xmlhttps://github.com/openapitools/openapi-generator
                                                                                                                        serializableModelboolean - toggle "implements Serializable" for generated modelsfalse
                                                                                                                        singleContentTypesWhether to select only one produces/consumes content-type by operation.false
                                                                                                                        skipDefaultInterfaceWhether to generate default implementations for java8 interfacesfalse
                                                                                                                        snapshotVersionUses a SNAPSHOT version.
                                                                                                                        true
                                                                                                                        Use a SnapShot Version
                                                                                                                        false
                                                                                                                        Use a Release Version
                                                                                                                        		null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        sourceFoldersource folder for generated codesrc/main/java
                                                                                                                        swaggerDocketConfigGenerate Spring OpenAPI Docket configuration class.false
                                                                                                                        titleserver title name or client service nameOpenAPI Spring
                                                                                                                        unhandledExceptionDeclare operation methods to throw a generic exception and allow unhandled exceptions (useful for Spring @ControllerAdvice directives).false
                                                                                                                        useBeanValidationUse BeanValidation API annotationstrue
                                                                                                                        useOptionalUse Optional container for optional parametersfalse
                                                                                                                        useTagsuse tags for creating interface and controller classnamesfalse
                                                                                                                        virtualServiceGenerates the virtual service. For more details refer - https://github.com/elan-venture/virtualan/wikifalse
                                                                                                                        withXmlwhether 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

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports
                                                                                                                        Arrayjava.util.List
                                                                                                                        ArrayListjava.util.ArrayList
                                                                                                                        BigDecimaljava.math.BigDecimal
                                                                                                                        Datejava.util.Date
                                                                                                                        DateTimeorg.joda.time.*
                                                                                                                        Filejava.io.File
                                                                                                                        HashMapjava.util.HashMap
                                                                                                                        Listjava.util.*
                                                                                                                        LocalDateorg.joda.time.*
                                                                                                                        LocalDateTimeorg.joda.time.*
                                                                                                                        LocalTimeorg.joda.time.*
                                                                                                                        Mapjava.util.Map
                                                                                                                        Setjava.util.*
                                                                                                                        Timestampjava.sql.Timestamp
                                                                                                                        URIjava.net.URI
                                                                                                                        UUIDjava.util.UUID

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArrayList
                                                                                                                        mapHashMap

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Boolean
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • boolean
                                                                                                                        • byte[]

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • apiclient
                                                                                                                        • apiexception
                                                                                                                        • apiresponse
                                                                                                                        • assert
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • configuration
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • default
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extends
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • goto
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • localreturntype
                                                                                                                        • localvaraccept
                                                                                                                        • localvaraccepts
                                                                                                                        • localvarauthnames
                                                                                                                        • localvarcollectionqueryparams
                                                                                                                        • localvarcontenttype
                                                                                                                        • localvarcontenttypes
                                                                                                                        • localvarcookieparams
                                                                                                                        • localvarformparams
                                                                                                                        • localvarheaderparams
                                                                                                                        • localvarpath
                                                                                                                        • localvarpostbody
                                                                                                                        • localvarqueryparams
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • object
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • strictfp
                                                                                                                        • stringutil
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • transient
                                                                                                                        • try
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✓OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✓OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/swift2-deprecated/index.html b/docs/generators/swift2-deprecated/index.html index db3dabb2f4b..4aeb8f77bbc 100644 --- a/docs/generators/swift2-deprecated/index.html +++ b/docs/generators/swift2-deprecated/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for swift2-deprecated

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocsetURLDocset URL used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                                                                        unwrapRequiredTreat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schemanull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • Data
                                                                                                                        • Double
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • LINE
                                                                                                                        • Protocol
                                                                                                                        • Self
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • Void
                                                                                                                        • as
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • defer
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • fileprivate
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • guard
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • indirect
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • open
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • repeat
                                                                                                                        • required
                                                                                                                        • rethrows
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • willSet

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for swift2-deprecated

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocsetURLDocset URL used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                                                                        unwrapRequiredTreat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schemanull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • Data
                                                                                                                        • Double
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • LINE
                                                                                                                        • Protocol
                                                                                                                        • Self
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • Void
                                                                                                                        • as
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • defer
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • fileprivate
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • guard
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • indirect
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • open
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • repeat
                                                                                                                        • required
                                                                                                                        • rethrows
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • willSet

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/swift3-deprecated/index.html b/docs/generators/swift3-deprecated/index.html index 9c3c3c84069..35df6eb0f58 100644 --- a/docs/generators/swift3-deprecated/index.html +++ b/docs/generators/swift3-deprecated/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for swift3-deprecated

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
                                                                                                                        objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocsetURLDocset URL used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                                                                        unwrapRequiredTreat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schemanull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • Data
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • LINE
                                                                                                                        • Protocol
                                                                                                                        • Response
                                                                                                                        • Self
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • URL
                                                                                                                        • Void
                                                                                                                        • as
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • required
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • true
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for swift3-deprecated

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
                                                                                                                        objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocsetURLDocset URL used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                                                                        unwrapRequiredTreat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schemanull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • Data
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • LINE
                                                                                                                        • Protocol
                                                                                                                        • Response
                                                                                                                        • Self
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • URL
                                                                                                                        • Void
                                                                                                                        • as
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • required
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • true
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✗OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/swift4/index.html b/docs/generators/swift4/index.html index 649dd2928f8..28ab32fc8c0 100644 --- a/docs/generators/swift4/index.html +++ b/docs/generators/swift4/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for swift4

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
                                                                                                                        nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
                                                                                                                        objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocsetURLDocset URL used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift, Result are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                                                                        unwrapRequiredTreat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schemanull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Data
                                                                                                                        • Date
                                                                                                                        • Decimal
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • URL
                                                                                                                        • UUID
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • #available
                                                                                                                        • #colorLiteral
                                                                                                                        • #column
                                                                                                                        • #else
                                                                                                                        • #elseif
                                                                                                                        • #endif
                                                                                                                        • #file
                                                                                                                        • #fileLiteral
                                                                                                                        • #function
                                                                                                                        • #if
                                                                                                                        • #imageLiteral
                                                                                                                        • #line
                                                                                                                        • #selector
                                                                                                                        • #sourceLocation
                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Array
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • ClosedRange
                                                                                                                        • Codable
                                                                                                                        • CountableClosedRange
                                                                                                                        • CountableRange
                                                                                                                        • Data
                                                                                                                        • Decodable
                                                                                                                        • Dictionary
                                                                                                                        • Double
                                                                                                                        • Encodable
                                                                                                                        • Error
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Float32
                                                                                                                        • Float64
                                                                                                                        • Float80
                                                                                                                        • Int
                                                                                                                        • Int16
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • Int8
                                                                                                                        • LINE
                                                                                                                        • OptionSet
                                                                                                                        • Optional
                                                                                                                        • Protocol
                                                                                                                        • Range
                                                                                                                        • Response
                                                                                                                        • Self
                                                                                                                        • Set
                                                                                                                        • StaticString
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • UInt
                                                                                                                        • UInt16
                                                                                                                        • UInt32
                                                                                                                        • UInt64
                                                                                                                        • UInt8
                                                                                                                        • URL
                                                                                                                        • Unicode
                                                                                                                        • Void
                                                                                                                        • _
                                                                                                                        • as
                                                                                                                        • associatedtype
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • defer
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • fileprivate
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • guard
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • indirect
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • open
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • repeat
                                                                                                                        • required
                                                                                                                        • rethrows
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • willSet

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for swift4

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
                                                                                                                        nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
                                                                                                                        objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocsetURLDocset URL used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift, Result are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull
                                                                                                                        unwrapRequiredTreat 'required' properties in response as non-optional (which would crash the app if api returns null as opposed to required option specified in json schemanull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Data
                                                                                                                        • Date
                                                                                                                        • Decimal
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • URL
                                                                                                                        • UUID
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • #available
                                                                                                                        • #colorLiteral
                                                                                                                        • #column
                                                                                                                        • #else
                                                                                                                        • #elseif
                                                                                                                        • #endif
                                                                                                                        • #file
                                                                                                                        • #fileLiteral
                                                                                                                        • #function
                                                                                                                        • #if
                                                                                                                        • #imageLiteral
                                                                                                                        • #line
                                                                                                                        • #selector
                                                                                                                        • #sourceLocation
                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Array
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • ClosedRange
                                                                                                                        • Codable
                                                                                                                        • CountableClosedRange
                                                                                                                        • CountableRange
                                                                                                                        • Data
                                                                                                                        • Decodable
                                                                                                                        • Dictionary
                                                                                                                        • Double
                                                                                                                        • Encodable
                                                                                                                        • Error
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Float32
                                                                                                                        • Float64
                                                                                                                        • Float80
                                                                                                                        • Int
                                                                                                                        • Int16
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • Int8
                                                                                                                        • LINE
                                                                                                                        • OptionSet
                                                                                                                        • Optional
                                                                                                                        • Protocol
                                                                                                                        • Range
                                                                                                                        • Response
                                                                                                                        • Self
                                                                                                                        • Set
                                                                                                                        • StaticString
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • UInt
                                                                                                                        • UInt16
                                                                                                                        • UInt32
                                                                                                                        • UInt64
                                                                                                                        • UInt8
                                                                                                                        • URL
                                                                                                                        • Unicode
                                                                                                                        • Void
                                                                                                                        • _
                                                                                                                        • as
                                                                                                                        • associatedtype
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • defer
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • fileprivate
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • guard
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • indirect
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • open
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • repeat
                                                                                                                        • required
                                                                                                                        • rethrows
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • willSet

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✗OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✗OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/swift5/index.html b/docs/generators/swift5/index.html index 5196ad46c88..0780ef05cf5 100644 --- a/docs/generators/swift5/index.html +++ b/docs/generators/swift5/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for swift5

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
                                                                                                                        libraryLibrary template (sub-template) to use
                                                                                                                        urlsession
                                                                                                                        [DEFAULT] HTTP client: URLSession
                                                                                                                        alamofire
                                                                                                                        HTTP client: Alamofire
                                                                                                                        		urlsession
                                                                                                                        nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
                                                                                                                        objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift, Result, Combine are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Data
                                                                                                                        • Date
                                                                                                                        • Decimal
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • URL
                                                                                                                        • UUID
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • #available
                                                                                                                        • #colorLiteral
                                                                                                                        • #column
                                                                                                                        • #else
                                                                                                                        • #elseif
                                                                                                                        • #endif
                                                                                                                        • #file
                                                                                                                        • #fileLiteral
                                                                                                                        • #function
                                                                                                                        • #if
                                                                                                                        • #imageLiteral
                                                                                                                        • #line
                                                                                                                        • #selector
                                                                                                                        • #sourceLocation
                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Array
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • ClosedRange
                                                                                                                        • Codable
                                                                                                                        • CountableClosedRange
                                                                                                                        • CountableRange
                                                                                                                        • Data
                                                                                                                        • Decodable
                                                                                                                        • Dictionary
                                                                                                                        • Double
                                                                                                                        • Encodable
                                                                                                                        • Error
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Float32
                                                                                                                        • Float64
                                                                                                                        • Float80
                                                                                                                        • Int
                                                                                                                        • Int16
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • Int8
                                                                                                                        • LINE
                                                                                                                        • OptionSet
                                                                                                                        • Optional
                                                                                                                        • Protocol
                                                                                                                        • Range
                                                                                                                        • Response
                                                                                                                        • Self
                                                                                                                        • Set
                                                                                                                        • StaticString
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • UInt
                                                                                                                        • UInt16
                                                                                                                        • UInt32
                                                                                                                        • UInt64
                                                                                                                        • UInt8
                                                                                                                        • URL
                                                                                                                        • Unicode
                                                                                                                        • Void
                                                                                                                        • _
                                                                                                                        • as
                                                                                                                        • associatedtype
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • defer
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • fileprivate
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • guard
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • indirect
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • open
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • repeat
                                                                                                                        • required
                                                                                                                        • rethrows
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • willSet

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✓OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for swift5

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        hideGenerationTimestampHides the generation timestamp when files are generated.true
                                                                                                                        lenientTypeCastAccept and cast values for simple types (string->bool, string->int, int->string)false
                                                                                                                        libraryLibrary template (sub-template) to use
                                                                                                                        urlsession
                                                                                                                        [DEFAULT] HTTP client: URLSession
                                                                                                                        alamofire
                                                                                                                        HTTP client: Alamofire
                                                                                                                        		urlsession
                                                                                                                        nonPublicApiGenerates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.(default: false)null
                                                                                                                        objcCompatibleAdd additional properties and methods for Objective-C compatibility (default: false)null
                                                                                                                        podAuthorsAuthors used for Podspecnull
                                                                                                                        podDescriptionDescription used for Podspecnull
                                                                                                                        podDocumentationURLDocumentation URL used for Podspecnull
                                                                                                                        podHomepageHomepage used for Podspecnull
                                                                                                                        podLicenseLicense used for Podspecnull
                                                                                                                        podScreenshotsScreenshots used for Podspecnull
                                                                                                                        podSocialMediaURLSocial Media URL used for Podspecnull
                                                                                                                        podSourceSource information used for Podspecnull
                                                                                                                        podSummarySummary used for Podspecnull
                                                                                                                        podVersionVersion used for Podspecnull
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        projectNameProject name in Xcodenull
                                                                                                                        responseAsOptionally use libraries to manage response. Currently PromiseKit, RxSwift, Result, Combine are available.null
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        swiftUseApiNamespaceFlag to make all the API classes inner-class of {{projectName}}APInull

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Bool
                                                                                                                        • Character
                                                                                                                        • Data
                                                                                                                        • Date
                                                                                                                        • Decimal
                                                                                                                        • Double
                                                                                                                        • Float
                                                                                                                        • Int
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • String
                                                                                                                        • URL
                                                                                                                        • UUID
                                                                                                                        • Void

                                                                                                                        RESERVED WORDS

                                                                                                                        • #available
                                                                                                                        • #colorLiteral
                                                                                                                        • #column
                                                                                                                        • #else
                                                                                                                        • #elseif
                                                                                                                        • #endif
                                                                                                                        • #file
                                                                                                                        • #fileLiteral
                                                                                                                        • #function
                                                                                                                        • #if
                                                                                                                        • #imageLiteral
                                                                                                                        • #line
                                                                                                                        • #selector
                                                                                                                        • #sourceLocation
                                                                                                                        • Any
                                                                                                                        • AnyObject
                                                                                                                        • Array
                                                                                                                        • Bool
                                                                                                                        • COLUMN
                                                                                                                        • Character
                                                                                                                        • Class
                                                                                                                        • ClosedRange
                                                                                                                        • Codable
                                                                                                                        • CountableClosedRange
                                                                                                                        • CountableRange
                                                                                                                        • Data
                                                                                                                        • Decodable
                                                                                                                        • Dictionary
                                                                                                                        • Double
                                                                                                                        • Encodable
                                                                                                                        • Error
                                                                                                                        • ErrorResponse
                                                                                                                        • FILE
                                                                                                                        • FUNCTION
                                                                                                                        • Float
                                                                                                                        • Float32
                                                                                                                        • Float64
                                                                                                                        • Float80
                                                                                                                        • Int
                                                                                                                        • Int16
                                                                                                                        • Int32
                                                                                                                        • Int64
                                                                                                                        • Int8
                                                                                                                        • LINE
                                                                                                                        • OptionSet
                                                                                                                        • Optional
                                                                                                                        • Protocol
                                                                                                                        • Range
                                                                                                                        • Response
                                                                                                                        • Self
                                                                                                                        • Set
                                                                                                                        • StaticString
                                                                                                                        • String
                                                                                                                        • Type
                                                                                                                        • UInt
                                                                                                                        • UInt16
                                                                                                                        • UInt32
                                                                                                                        • UInt64
                                                                                                                        • UInt8
                                                                                                                        • URL
                                                                                                                        • Unicode
                                                                                                                        • Void
                                                                                                                        • _
                                                                                                                        • as
                                                                                                                        • associatedtype
                                                                                                                        • associativity
                                                                                                                        • break
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • class
                                                                                                                        • continue
                                                                                                                        • convenience
                                                                                                                        • default
                                                                                                                        • defer
                                                                                                                        • deinit
                                                                                                                        • didSet
                                                                                                                        • do
                                                                                                                        • dynamic
                                                                                                                        • dynamicType
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • extension
                                                                                                                        • fallthrough
                                                                                                                        • false
                                                                                                                        • fileprivate
                                                                                                                        • final
                                                                                                                        • for
                                                                                                                        • func
                                                                                                                        • get
                                                                                                                        • guard
                                                                                                                        • if
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • indirect
                                                                                                                        • infix
                                                                                                                        • init
                                                                                                                        • inout
                                                                                                                        • internal
                                                                                                                        • is
                                                                                                                        • lazy
                                                                                                                        • left
                                                                                                                        • let
                                                                                                                        • mutating
                                                                                                                        • nil
                                                                                                                        • none
                                                                                                                        • nonmutating
                                                                                                                        • open
                                                                                                                        • operator
                                                                                                                        • optional
                                                                                                                        • override
                                                                                                                        • postfix
                                                                                                                        • precedence
                                                                                                                        • prefix
                                                                                                                        • private
                                                                                                                        • protocol
                                                                                                                        • public
                                                                                                                        • repeat
                                                                                                                        • required
                                                                                                                        • rethrows
                                                                                                                        • return
                                                                                                                        • right
                                                                                                                        • self
                                                                                                                        • set
                                                                                                                        • static
                                                                                                                        • struct
                                                                                                                        • subscript
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • throw
                                                                                                                        • throws
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typealias
                                                                                                                        • unowned
                                                                                                                        • var
                                                                                                                        • weak
                                                                                                                        • where
                                                                                                                        • while
                                                                                                                        • willSet

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✗ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✗ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✓OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✓OAS2,OAS3
                                                                                                                        ApiKey✓OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✓OAS3
                                                                                                                        OAuth2_Implicit✓OAS2,OAS3
                                                                                                                        OAuth2_Password✓OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✓OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✓OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-angular/index.html b/docs/generators/typescript-angular/index.html index 53ee4c15956..934642fe729 100644 --- a/docs/generators/typescript-angular/index.html +++ b/docs/generators/typescript-angular/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-angular

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiModulePrefixThe prefix of the generated ApiModule.null
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        fileNamingNaming convention for the output files: 'camelCase', 'kebab-case'.camelCase
                                                                                                                        modelFileSuffixThe suffix of the file of the generated model (model<suffix>.ts).null
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        modelSuffixThe suffix of the generated model.null
                                                                                                                        ngVersionThe version of Angular.8.0.0
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        providedInRootUse this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).false
                                                                                                                        serviceFileSuffixThe suffix of the file of the generated service (service<suffix>.ts)..service
                                                                                                                        serviceSuffixThe suffix of the generated service.Service
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        stringEnumsGenerate string enums instead of objects for enum values.false
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                                                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Blob
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-angular

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        apiModulePrefixThe prefix of the generated ApiModule.null
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        fileNamingNaming convention for the output files: 'camelCase', 'kebab-case'.camelCase
                                                                                                                        modelFileSuffixThe suffix of the file of the generated model (model<suffix>.ts).null
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        modelSuffixThe suffix of the generated model.null
                                                                                                                        ngVersionThe version of Angular.8.0.0
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        providedInRootUse this property to provide Injectables in root (it is only valid in angular version greater or equal to 6.0.0).false
                                                                                                                        serviceFileSuffixThe suffix of the file of the generated service (service<suffix>.ts)..service
                                                                                                                        serviceSuffixThe suffix of the generated service.Service
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        stringEnumsGenerate string enums instead of objects for enum values.false
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                                                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Blob
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-angularjs/index.html b/docs/generators/typescript-angularjs/index.html index 6ab97ab5c4a..d5af5b5cf41 100644 --- a/docs/generators/typescript-angularjs/index.html +++ b/docs/generators/typescript-angularjs/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-angularjs

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-angularjs

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-aurelia/index.html b/docs/generators/typescript-aurelia/index.html index 6d2708fb81c..48a39ae942f 100644 --- a/docs/generators/typescript-aurelia/index.html +++ b/docs/generators/typescript-aurelia/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-aurelia

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-aurelia

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-axios/index.html b/docs/generators/typescript-axios/index.html index fcca2924d93..de4a8514fd4 100644 --- a/docs/generators/typescript-axios/index.html +++ b/docs/generators/typescript-axios/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-axios

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url of your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false
                                                                                                                        withSeparateModelsAndApiPut the model and api in separate folders and in separate classesfalse
                                                                                                                        withoutPrefixEnumsDon't prefix enum names with class namesfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-axios

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url of your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false
                                                                                                                        withSeparateModelsAndApiPut the model and api in separate folders and in separate classesfalse
                                                                                                                        withoutPrefixEnumsDon't prefix enum names with class namesfalse

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-fetch/index.html b/docs/generators/typescript-fetch/index.html index 8aa58dd2725..4411550f822 100644 --- a/docs/generators/typescript-fetch/index.html +++ b/docs/generators/typescript-fetch/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-fetch

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prefixParameterInterfacesSetting this property to true will generate parameter interface declarations prefixed with API class name to avoid name conflicts.false
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        typescriptThreePlusSetting this property to true will generate TypeScript 3.6+ compatible code.false
                                                                                                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.true
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • ApiResponse
                                                                                                                        • BASE_PATH
                                                                                                                        • BaseAPI
                                                                                                                        • BlobApiResponse
                                                                                                                        • COLLECTION_FORMATS
                                                                                                                        • Configuration
                                                                                                                        • ConfigurationParameters
                                                                                                                        • FetchAPI
                                                                                                                        • FetchParams
                                                                                                                        • HTTPBody
                                                                                                                        • HTTPHeaders
                                                                                                                        • HTTPMethod
                                                                                                                        • HTTPQuery
                                                                                                                        • JSONApiResponse
                                                                                                                        • Middleware
                                                                                                                        • ModelPropertyNaming
                                                                                                                        • RequestContext
                                                                                                                        • RequestOpts
                                                                                                                        • RequiredError
                                                                                                                        • ResponseContext
                                                                                                                        • ResponseTransformer
                                                                                                                        • TextApiResponse
                                                                                                                        • VoidApiResponse
                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • configuration
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • exists
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-fetch

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prefixParameterInterfacesSetting this property to true will generate parameter interface declarations prefixed with API class name to avoid name conflicts.false
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        typescriptThreePlusSetting this property to true will generate TypeScript 3.6+ compatible code.false
                                                                                                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.true
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • ApiResponse
                                                                                                                        • BASE_PATH
                                                                                                                        • BaseAPI
                                                                                                                        • BlobApiResponse
                                                                                                                        • COLLECTION_FORMATS
                                                                                                                        • Configuration
                                                                                                                        • ConfigurationParameters
                                                                                                                        • FetchAPI
                                                                                                                        • FetchParams
                                                                                                                        • HTTPBody
                                                                                                                        • HTTPHeaders
                                                                                                                        • HTTPMethod
                                                                                                                        • HTTPQuery
                                                                                                                        • JSONApiResponse
                                                                                                                        • Middleware
                                                                                                                        • ModelPropertyNaming
                                                                                                                        • RequestContext
                                                                                                                        • RequestOpts
                                                                                                                        • RequiredError
                                                                                                                        • ResponseContext
                                                                                                                        • ResponseTransformer
                                                                                                                        • TextApiResponse
                                                                                                                        • VoidApiResponse
                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • configuration
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • exists
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-inversify/index.html b/docs/generators/typescript-inversify/index.html index c2dffb7bb54..65aa82e12ab 100644 --- a/docs/generators/typescript-inversify/index.html +++ b/docs/generators/typescript-inversify/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-inversify

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                                                                        usePromiseSetting this property to use promise instead of observable inside every service.false
                                                                                                                        useRxJS6Setting this property to use rxjs 6 instead of rxjs 5.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Blob
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • map
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-inversify

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        taggedUnionsUse discriminators to create tagged unions instead of extending interfaces.false
                                                                                                                        usePromiseSetting this property to use promise instead of observable inside every service.false
                                                                                                                        useRxJS6Setting this property to use rxjs 6 instead of rxjs 5.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Blob
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • map
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-jquery/index.html b/docs/generators/typescript-jquery/index.html index dbb29aef0e4..3db0da33670 100644 --- a/docs/generators/typescript-jquery/index.html +++ b/docs/generators/typescript-jquery/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-jquery

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        jqueryAlreadyImportedWhen using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import itfalse
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-jquery

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        jqueryAlreadyImportedWhen using this in legacy app using mix of typescript and javascript, this will only declare jquery and not import itfalse
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-node/index.html b/docs/generators/typescript-node/index.html index 9ea9fd988d9..ad1a1b174c7 100644 --- a/docs/generators/typescript-node/index.html +++ b/docs/generators/typescript-node/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-node

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Buffer
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • ReadStream
                                                                                                                        • RequestDetailedFile
                                                                                                                        • RequestFile
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-node

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Buffer
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • ReadStream
                                                                                                                        • RequestDetailedFile
                                                                                                                        • RequestFile
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-redux-query/index.html b/docs/generators/typescript-redux-query/index.html index 6f69b0bb02e..a1b85c6b12d 100644 --- a/docs/generators/typescript-redux-query/index.html +++ b/docs/generators/typescript-redux-query/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-redux-query

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.true
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • ApiResponse
                                                                                                                        • BASE_PATH
                                                                                                                        • BaseAPI
                                                                                                                        • BlobApiResponse
                                                                                                                        • COLLECTION_FORMATS
                                                                                                                        • Configuration
                                                                                                                        • ConfigurationParameters
                                                                                                                        • HTTPBody
                                                                                                                        • HTTPHeaders
                                                                                                                        • HTTPMethod
                                                                                                                        • HTTPQuery
                                                                                                                        • JSONApiResponse
                                                                                                                        • Middleware
                                                                                                                        • ModelPropertyNaming
                                                                                                                        • RequestContext
                                                                                                                        • RequestOpts
                                                                                                                        • RequiredError
                                                                                                                        • ResponseContext
                                                                                                                        • ResponseTransformer
                                                                                                                        • TextApiResponse
                                                                                                                        • VoidApiResponse
                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • configuration
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • exists
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-redux-query

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        useSingleRequestParameterSetting this property to true will generate functions with a single argument containing all API endpoint parameters instead of one argument per parameter.true
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • ApiResponse
                                                                                                                        • BASE_PATH
                                                                                                                        • BaseAPI
                                                                                                                        • BlobApiResponse
                                                                                                                        • COLLECTION_FORMATS
                                                                                                                        • Configuration
                                                                                                                        • ConfigurationParameters
                                                                                                                        • HTTPBody
                                                                                                                        • HTTPHeaders
                                                                                                                        • HTTPMethod
                                                                                                                        • HTTPQuery
                                                                                                                        • JSONApiResponse
                                                                                                                        • Middleware
                                                                                                                        • ModelPropertyNaming
                                                                                                                        • RequestContext
                                                                                                                        • RequestOpts
                                                                                                                        • RequiredError
                                                                                                                        • ResponseContext
                                                                                                                        • ResponseTransformer
                                                                                                                        • TextApiResponse
                                                                                                                        • VoidApiResponse
                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • configuration
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • exists
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/generators/typescript-rxjs/index.html b/docs/generators/typescript-rxjs/index.html index b42e0ccfa98..67ce35f4640 100644 --- a/docs/generators/typescript-rxjs/index.html +++ b/docs/generators/typescript-rxjs/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        Config Options for typescript-rxjs

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Blob
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • AjaxRequest
                                                                                                                        • AjaxResponse
                                                                                                                        • BASE_PATH
                                                                                                                        • BaseAPI
                                                                                                                        • COLLECTION_FORMATS
                                                                                                                        • Configuration
                                                                                                                        • ConfigurationParameters
                                                                                                                        • HttpBody
                                                                                                                        • HttpHeaders
                                                                                                                        • HttpMethod
                                                                                                                        • HttpQuery
                                                                                                                        • Middleware
                                                                                                                        • RequestArgs
                                                                                                                        • RequestOpts
                                                                                                                        • ResponseArgs
                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        Config Options for typescript-rxjs

                                                                                                                        OptionDescriptionValuesDefault
                                                                                                                        allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
                                                                                                                        ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
                                                                                                                        enumNameSuffixSuffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)v4-compat
                                                                                                                        enumPropertyNamingNaming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'PascalCase
                                                                                                                        modelPropertyNamingNaming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original namecamelCase
                                                                                                                        npmNameThe name under which you want to publish generated npm package. Required to generate a full packagenull
                                                                                                                        npmRepositoryUse this property to set an url your private npmRepo in the package.jsonnull
                                                                                                                        npmVersionThe version of your npm package. If not provided, using the version from the OpenAPI specification file.1.0.0
                                                                                                                        nullSafeAdditionalPropsSet to make additional properties types declare that their indexer may return undefinedfalse
                                                                                                                        prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
                                                                                                                        snapshotWhen setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmmfalse
                                                                                                                        sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
                                                                                                                        sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
                                                                                                                        supportsES6Generate code that conforms to ES6.false
                                                                                                                        withInterfacesSetting this property to true will generate interfaces next to the default class implementations.false

                                                                                                                        IMPORT MAPPING

                                                                                                                        Type/AliasImports

                                                                                                                        INSTANTIATION TYPES

                                                                                                                        Type/AliasInstantiated By
                                                                                                                        arrayArray

                                                                                                                        LANGUAGE PRIMITIVES

                                                                                                                        • Array
                                                                                                                        • Blob
                                                                                                                        • Boolean
                                                                                                                        • Date
                                                                                                                        • Double
                                                                                                                        • Error
                                                                                                                        • File
                                                                                                                        • Float
                                                                                                                        • Integer
                                                                                                                        • Long
                                                                                                                        • Map
                                                                                                                        • Object
                                                                                                                        • String
                                                                                                                        • any
                                                                                                                        • boolean
                                                                                                                        • number
                                                                                                                        • object
                                                                                                                        • string

                                                                                                                        RESERVED WORDS

                                                                                                                        • AjaxRequest
                                                                                                                        • AjaxResponse
                                                                                                                        • BASE_PATH
                                                                                                                        • BaseAPI
                                                                                                                        • COLLECTION_FORMATS
                                                                                                                        • Configuration
                                                                                                                        • ConfigurationParameters
                                                                                                                        • HttpBody
                                                                                                                        • HttpHeaders
                                                                                                                        • HttpMethod
                                                                                                                        • HttpQuery
                                                                                                                        • Middleware
                                                                                                                        • RequestArgs
                                                                                                                        • RequestOpts
                                                                                                                        • ResponseArgs
                                                                                                                        • abstract
                                                                                                                        • await
                                                                                                                        • boolean
                                                                                                                        • break
                                                                                                                        • byte
                                                                                                                        • case
                                                                                                                        • catch
                                                                                                                        • char
                                                                                                                        • class
                                                                                                                        • const
                                                                                                                        • continue
                                                                                                                        • debugger
                                                                                                                        • default
                                                                                                                        • delete
                                                                                                                        • do
                                                                                                                        • double
                                                                                                                        • else
                                                                                                                        • enum
                                                                                                                        • export
                                                                                                                        • extends
                                                                                                                        • false
                                                                                                                        • final
                                                                                                                        • finally
                                                                                                                        • float
                                                                                                                        • for
                                                                                                                        • formParams
                                                                                                                        • function
                                                                                                                        • goto
                                                                                                                        • headerParams
                                                                                                                        • if
                                                                                                                        • implements
                                                                                                                        • import
                                                                                                                        • in
                                                                                                                        • instanceof
                                                                                                                        • int
                                                                                                                        • interface
                                                                                                                        • let
                                                                                                                        • long
                                                                                                                        • native
                                                                                                                        • new
                                                                                                                        • null
                                                                                                                        • package
                                                                                                                        • private
                                                                                                                        • protected
                                                                                                                        • public
                                                                                                                        • queryParameters
                                                                                                                        • requestOptions
                                                                                                                        • return
                                                                                                                        • short
                                                                                                                        • static
                                                                                                                        • super
                                                                                                                        • switch
                                                                                                                        • synchronized
                                                                                                                        • this
                                                                                                                        • throw
                                                                                                                        • transient
                                                                                                                        • true
                                                                                                                        • try
                                                                                                                        • typeof
                                                                                                                        • useFormData
                                                                                                                        • var
                                                                                                                        • varLocalDeferred
                                                                                                                        • varLocalPath
                                                                                                                        • void
                                                                                                                        • volatile
                                                                                                                        • while
                                                                                                                        • with
                                                                                                                        • yield

                                                                                                                        FEATURE SET

                                                                                                                        Client Modification Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasePath✓ToolingExtension
                                                                                                                        Authorizations✗ToolingExtension
                                                                                                                        UserAgent✗ToolingExtension

                                                                                                                        Data Type Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Int32✓OAS2,OAS3
                                                                                                                        Int64✓OAS2,OAS3
                                                                                                                        Float✓OAS2,OAS3
                                                                                                                        Double✓OAS2,OAS3
                                                                                                                        Decimal✓ToolingExtension
                                                                                                                        String✓OAS2,OAS3
                                                                                                                        Byte✓OAS2,OAS3
                                                                                                                        Binary✓OAS2,OAS3
                                                                                                                        Boolean✓OAS2,OAS3
                                                                                                                        Date✓OAS2,OAS3
                                                                                                                        DateTime✓OAS2,OAS3
                                                                                                                        Password✓OAS2,OAS3
                                                                                                                        File✓OAS2
                                                                                                                        Array✓OAS2,OAS3
                                                                                                                        Maps✓ToolingExtension
                                                                                                                        CollectionFormat✓OAS2
                                                                                                                        CollectionFormatMulti✓OAS2
                                                                                                                        Enum✓OAS2,OAS3
                                                                                                                        ArrayOfEnum✓ToolingExtension
                                                                                                                        ArrayOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfModel✓ToolingExtension
                                                                                                                        ArrayOfCollectionOfEnum✓ToolingExtension
                                                                                                                        MapOfEnum✓ToolingExtension
                                                                                                                        MapOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfPrimitives✓ToolingExtension
                                                                                                                        MapOfCollectionOfModel✓ToolingExtension
                                                                                                                        MapOfCollectionOfEnum✓ToolingExtension

                                                                                                                        Documentation Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Readme✓ToolingExtension
                                                                                                                        Model✓ToolingExtension
                                                                                                                        Api✓ToolingExtension

                                                                                                                        Global Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Host✓OAS2,OAS3
                                                                                                                        BasePath✓OAS2,OAS3
                                                                                                                        Info✓OAS2,OAS3
                                                                                                                        Schemes✗OAS2,OAS3
                                                                                                                        PartialSchemes✓OAS2,OAS3
                                                                                                                        Consumes✓OAS2
                                                                                                                        Produces✓OAS2
                                                                                                                        ExternalDocumentation✓OAS2,OAS3
                                                                                                                        Examples✓OAS2,OAS3
                                                                                                                        XMLStructureDefinitions✗OAS2,OAS3
                                                                                                                        MultiServer✗OAS3
                                                                                                                        ParameterizedServer✗OAS3
                                                                                                                        ParameterStyling✗OAS3
                                                                                                                        Callbacks✗OAS3
                                                                                                                        LinkObjects✗OAS3

                                                                                                                        Parameter Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Path✓OAS2,OAS3
                                                                                                                        Query✓OAS2,OAS3
                                                                                                                        Header✓OAS2,OAS3
                                                                                                                        Body✓OAS2
                                                                                                                        FormUnencoded✓OAS2
                                                                                                                        FormMultipart✓OAS2
                                                                                                                        Cookie✓OAS3

                                                                                                                        Schema Support Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        Simple✓OAS2,OAS3
                                                                                                                        Composite✓OAS2,OAS3
                                                                                                                        Polymorphism✓OAS2,OAS3
                                                                                                                        Union✗OAS3

                                                                                                                        Security Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        BasicAuth✗OAS2,OAS3
                                                                                                                        ApiKey✗OAS2,OAS3
                                                                                                                        OpenIDConnect✗OAS3
                                                                                                                        BearerToken✗OAS3
                                                                                                                        OAuth2_Implicit✗OAS2,OAS3
                                                                                                                        OAuth2_Password✗OAS2,OAS3
                                                                                                                        OAuth2_ClientCredentials✗OAS2,OAS3
                                                                                                                        OAuth2_AuthorizationCode✗OAS2,OAS3

                                                                                                                        Wire Format Feature

                                                                                                                        NameSupportedDefined By
                                                                                                                        JSON✓OAS2,OAS3
                                                                                                                        XML✓OAS2,OAS3
                                                                                                                        PROTOBUF✗ToolingExtension
                                                                                                                        Custom✗OAS2,OAS3
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/installation/index.html b/docs/installation/index.html index 60b8e48197d..7db2780e613 100644 --- a/docs/installation/index.html +++ b/docs/installation/index.html @@ -21,7 +21,7 @@ - + @@ -31,20 +31,20 @@ Installing OpenAPI Generator's CLI tool allows users to generate all available generators from the command line.

                                                                                                                        Some of the following are cross-platform options and some are not, these are called out where possible.

                                                                                                                        NPM

                                                                                                                        Platform(s): Linux, macOS, Windows

                                                                                                                        The NPM package wrapper is cross-platform wrapper around the .jar artifact. It works by providing a CLI wrapper atop the JAR's command line options. This gives a simple interface layer which normalizes usage of the command line across operating systems, removing some differences in how options or switches are passed to the tool (depending on OS). Install the latest version of the tool globally, exposing the CLI on the command line:

                                                                                                                        npm install @openapitools/openapi-generator-cli -g

                                                                                                                        To install a specific version of the tool, pass the version during installation:

                                                                                                                        npm install @openapitools/openapi-generator-cli@cli-4.2.3 -g

                                                                                                                        To install the tool as a dev dependency in your current project:

                                                                                                                        npm install @openapitools/openapi-generator-cli -D

                                                                                                                        Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                                                        npx openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                                                        npx will execute a globally available openapi-generator, and if not found it will fall back to project-local commands. The result is that the above command will work regardless of which installation method you've chosen.

                                                                                                                        Homebrew

                                                                                                                        Platform(s): macOS

                                                                                                                        Install via homebrew:

                                                                                                                        brew install openapi-generator

                                                                                                                        Then, generate a ruby client from a valid petstore.yaml doc:

                                                                                                                        openapi-generator generate -i petstore.yaml -g ruby -o /tmp/test/

                                                                                                                        Docker

                                                                                                                        Platform(s): Linux, macOS, Windows

                                                                                                                        The OpenAPI Generator Docker 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 doc with this image, you'll need to mount a local location as a volume. You'll then need to output the generated code to this mapped volume. Everything else works the same as if you ran the command on your host machine.

                                                                                                                        Here's an example generating a Go client:

                                                                                                                        docker run --rm \
                                                                                                                          -v ${PWD}:/local openapitools/openapi-generator-cli generate \
                                                                                                                          -i /local/petstore.yaml \
                                                                                                                          -g go \
                                                                                                                          -o /local/out/go

                                                                                                                        JAR

                                                                                                                        Platform(s): Linux, macOS, Windows

                                                                                                                        If you're looking for the latest stable version, you can grab it directly from Maven.org (Java 8 runtime at a minimum):

                                                                                                                        JAR location: https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.3/openapi-generator-cli-4.2.3.jar

                                                                                                                        For Mac/Linux users:

                                                                                                                        wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.3/openapi-generator-cli-4.2.3.jar -O openapi-generator-cli.jar

                                                                                                                        For Windows users, you will need to install wget or you can use Invoke-WebRequest in PowerShell (3.0+), e.g.

                                                                                                                        Invoke-WebRequest -OutFile openapi-generator-cli.jar https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.2.3/openapi-generator-cli-4.2.3.jar

                                                                                                                        After downloading the JAR, run java -jar openapi-generator-cli.jar help to show the usage.

                                                                                                                        For Mac users, please make sure Java 8 is installed (Tips: run java -version to check the version), and export JAVA_HOME in order to use the supported Java version:

                                                                                                                        export JAVA_HOME=`/usr/libexec/java_home -v 1.8`
                                                                                                                        export PATH=${JAVA_HOME}/bin:$PATH

                                                                                                                        Bash Launcher Script

                                                                                                                        Platform(s): Linux, macOS, Windows (variable)

                                                                                                                        One downside to manual JAR downloads is that you don't keep up-to-date with the latest released version. We have a Bash launcher script at bin/utils/openapi-generator.cli.sh which solves this problem.

                                                                                                                        To install the launcher script, copy the contents of the script to a location on your path and make the script executable.

                                                                                                                        An example of setting this up (NOTE: Always evaluate scripts curled from external systems before executing them).

                                                                                                                        mkdir -p ~/bin/openapitools
                                                                                                                        curl https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/bin/utils/openapi-generator-cli.sh > ~/bin/openapitools/openapi-generator-cli
                                                                                                                        chmod u+x ~/bin/openapitools/openapi-generator-cli
                                                                                                                        export PATH=$PATH:~/bin/openapitools/

                                                                                                                        Now, openapi-generator-cli is "installed". On invocation, it will query the GitHub repository for the most recently released version. If this matches the last downloaded jar, -it will execute as normal. If a newer version is found, the script will download the latest release and execute it.

                                                                                                                        If you need to invoke an older version of the generator, you can define the variable OPENAPI_GENERATOR_VERSION either ad hoc or globally. You can export this variable if you'd like to persist a specific release version.

                                                                                                                        Examples:

                                                                                                                        # Execute latest released openapi-generator-cli
                                                                                                                        openapi-generator-cli version
                                                                                                                        # Execute version 3.1.0 for the current invocation, regardless of the latest released version
                                                                                                                        OPENAPI_GENERATOR_VERSION=3.1.0 openapi-generator-cli version
                                                                                                                        # Execute version 3.1.0-SNAPSHOT for the current invocation
                                                                                                                        OPENAPI_GENERATOR_VERSION=3.1.0-SNAPSHOT openapi-generator-cli version
                                                                                                                        # Execute version 3.0.2 for every invocation in the current shell session
                                                                                                                        export OPENAPI_GENERATOR_VERSION=3.0.2
                                                                                                                        openapi-generator-cli version # is 3.0.2
                                                                                                                        openapi-generator-cli version # is also 3.0.2
                                                                                                                        # To "install" a specific version, set the variable in .bashrc/.bash_profile
                                                                                                                        echo "export OPENAPI_GENERATOR_VERSION=3.0.2" >> ~/.bashrc
                                                                                                                        source ~/.bashrc
                                                                                                                        openapi-generator-cli version # is always 3.0.2, unless any of the above overrides are done ad hoc
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +it will execute as normal. If a newer version is found, the script will download the latest release and execute it.

                                                                                                                        If you need to invoke an older version of the generator, you can define the variable OPENAPI_GENERATOR_VERSION either ad hoc or globally. You can export this variable if you'd like to persist a specific release version.

                                                                                                                        Examples:

                                                                                                                        # Execute latest released openapi-generator-cli
                                                                                                                        openapi-generator-cli version
                                                                                                                        # Execute version 3.1.0 for the current invocation, regardless of the latest released version
                                                                                                                        OPENAPI_GENERATOR_VERSION=3.1.0 openapi-generator-cli version
                                                                                                                        # Execute version 3.1.0-SNAPSHOT for the current invocation
                                                                                                                        OPENAPI_GENERATOR_VERSION=3.1.0-SNAPSHOT openapi-generator-cli version
                                                                                                                        # Execute version 3.0.2 for every invocation in the current shell session
                                                                                                                        export OPENAPI_GENERATOR_VERSION=3.0.2
                                                                                                                        openapi-generator-cli version # is 3.0.2
                                                                                                                        openapi-generator-cli version # is also 3.0.2
                                                                                                                        # To "install" a specific version, set the variable in .bashrc/.bash_profile
                                                                                                                        echo "export OPENAPI_GENERATOR_VERSION=3.0.2" >> ~/.bashrc
                                                                                                                        source ~/.bashrc
                                                                                                                        openapi-generator-cli version # is always 3.0.2, unless any of the above overrides are done ad hoc
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/integrations/index.html b/docs/integrations/index.html index 7f8589ced27..1dc28a82677 100644 --- a/docs/integrations/index.html +++ b/docs/integrations/index.html @@ -21,32 +21,32 @@ - +
                                                                                                                        -

                                                                                                                        Workflow Integrations

                                                                                                                        Workflow Integration (Maven, Github, CI/CD)

                                                                                                                        Gradle Integration

                                                                                                                        See the openapi-generator-gradle-plugin README for details related to configuring and using the Gradle Plugin.

                                                                                                                        Supported tasks include:

                                                                                                                        • Listing generators
                                                                                                                        • Validation of Open API 2.0 and 3.0 Specs
                                                                                                                        • Generating "Meta" generators
                                                                                                                        • Generating all generators supported by OpenAPI Generator

                                                                                                                        Maven Integration

                                                                                                                        See the openapi-generator-maven-plugin README for details related to configuring and using the Maven Plugin.

                                                                                                                        sbt Integration

                                                                                                                        Please refer to https://github.com/upstart-commerce/sbt-openapi-generator

                                                                                                                        Bazel Integration

                                                                                                                        Please refer to https://github.com/OpenAPITools/openapi-generator-bazel

                                                                                                                        GitHub Integration

                                                                                                                        To push the auto-generated SDK to GitHub, we provide git_push.sh to streamline the process. For example:

                                                                                                                        1) Create a new repository in GitHub (Ref: https://help.github.com/articles/creating-a-new-repository/)

                                                                                                                        2) Generate the SDK

                                                                                                                        java -jar openapi-generator-cli.jar generate \
                                                                                                                         -i modules/openapi-generator/src/test/resources/2_0/petstore.json -g perl \
                                                                                                                         --git-user-id "wing328" \
                                                                                                                         --git-repo-id "petstore-perl" \
                                                                                                                         --release-note "Github integration demo" \
                                                                                                                         -o /var/tmp/perl/petstore

                                                                                                                        3) Push the SDK to GitHub

                                                                                                                        cd /var/tmp/perl/petstore
                                                                                                                        /bin/sh ./git_push.sh

                                                                                                                        CI/CD

                                                                                                                        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 to let us know.

                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +

                                                                                                                        Workflow Integrations

                                                                                                                        Workflow Integration (Maven, Github, CI/CD)

                                                                                                                        Gradle Integration

                                                                                                                        See the openapi-generator-gradle-plugin README for details related to configuring and using the Gradle Plugin.

                                                                                                                        Supported tasks include:

                                                                                                                        • Listing generators
                                                                                                                        • Validation of Open API 2.0 and 3.0 Specs
                                                                                                                        • Generating "Meta" generators
                                                                                                                        • Generating all generators supported by OpenAPI Generator

                                                                                                                        Maven Integration

                                                                                                                        See the openapi-generator-maven-plugin README for details related to configuring and using the Maven Plugin.

                                                                                                                        sbt Integration

                                                                                                                        Please refer to https://github.com/upstart-commerce/sbt-openapi-generator

                                                                                                                        Bazel Integration

                                                                                                                        Please refer to https://github.com/OpenAPITools/openapi-generator-bazel

                                                                                                                        GitHub Integration

                                                                                                                        To push the auto-generated SDK to GitHub, we provide git_push.sh to streamline the process. For example:

                                                                                                                        1) Create a new repository in GitHub (Ref: https://help.github.com/articles/creating-a-new-repository/)

                                                                                                                        2) Generate the SDK

                                                                                                                        java -jar openapi-generator-cli.jar generate \
                                                                                                                         -i modules/openapi-generator/src/test/resources/2_0/petstore.json -g perl \
                                                                                                                         --git-user-id "wing328" \
                                                                                                                         --git-repo-id "petstore-perl" \
                                                                                                                         --release-note "Github integration demo" \
                                                                                                                         -o /var/tmp/perl/petstore

                                                                                                                        3) Push the SDK to GitHub

                                                                                                                        cd /var/tmp/perl/petstore
                                                                                                                        /bin/sh ./git_push.sh

                                                                                                                        CI/CD

                                                                                                                        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 to let us know.

                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/new-generator/index.html b/docs/new-generator/index.html index af2e1e53470..8c348adf056 100644 --- a/docs/new-generator/index.html +++ b/docs/new-generator/index.html @@ -21,32 +21,32 @@ - +
                                                                                                                        -

                                                                                                                        Create a New Generator

                                                                                                                        Creating a new generator which will become a part of the officially supported generators in OpenAPI Generator is pretty simple. We've created a helper script to bootstrap the operation. Let's look at the files necessary to create a new generator, then an example of bootstrapping a generator using the new.sh script in the root of the repository.

                                                                                                                        Required Files

                                                                                                                        The minimum set of files required to create a new generator are:

                                                                                                                        • A "Codegen" file
                                                                                                                          • exists under modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/
                                                                                                                          • defines language options
                                                                                                                          • defines framework options
                                                                                                                          • determines OpenAPI feature set
                                                                                                                          • extends the generation workflow
                                                                                                                        • SPI registration
                                                                                                                          • Above class must be referenced in modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
                                                                                                                          • Tells the generator that this class exists
                                                                                                                          • Allows for classpath extension (addition) of generators
                                                                                                                        • A minimal template
                                                                                                                          • Should include a README explaining usage
                                                                                                                          • Must include an api.mustache
                                                                                                                          • Exists under modules/openapi-generator/src/main/resources/ (plus embeddedTemplate dir value, see below)
                                                                                                                        • Sample scripts under ./bin and ./bin/windows
                                                                                                                          • Gives users a "real life" example of generated output
                                                                                                                          • Samples are used by CI to verify generators and test for regressions in some cases

                                                                                                                        Now, let's generate an example generator and then walk through the pieces. At the end, we'll touch on some known sticking points for new generator authors and provide some suggestions.

                                                                                                                        new.sh

                                                                                                                        The new.sh script in the root of the project is meant to simplify this process. Run ./new.sh --help.

                                                                                                                        Stubs out files for new generators
                                                                                                                        Usage:
                                                                                                                        ./new.sh [options]
                                                                                                                            Options:
                                                                                                                            -n  Required. Specify generator name, should be kebab-cased.
                                                                                                                            -c  Create a client generator
                                                                                                                            -s  Create a server generator
                                                                                                                            -d  Create a documentation generator
                                                                                                                            -t  When specified, creates test file(s) for the generator.
                                                                                                                            -h  Display help.
                                                                                                                        Examples:
                                                                                                                          Create a server generator for ktor:
                                                                                                                          ./new.sh -n kotlin -s
                                                                                                                            Creates:
                                                                                                                            modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java
                                                                                                                            modules/openapi-generator/src/main/resources/kotlin-server/README.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/kotlin-server/model.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/kotlin-server/api.mustache
                                                                                                                            bin/windows/kotlin-server-petstore.bat
                                                                                                                            bin/kotlin-server-petstore.sh
                                                                                                                          Create a generic C# server generator:
                                                                                                                          ./new.sh -n csharp -s -t
                                                                                                                            Creates:
                                                                                                                            modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpServerCodegen.java
                                                                                                                            modules/openapi-generator/src/main/resources/csharp-server/README.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/csharp-server/model.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/csharp-server/api.mustache
                                                                                                                            bin/windows/csharp-server-petstore.bat
                                                                                                                            bin/csharp-server-petstore.sh
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenTest.java
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenModelTest.java
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenOptionsTest.java
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/options/CsharpServerCodegenOptionsProvider.java

                                                                                                                        This script allows us to define a client, server, schema, or documentation generator. We'll focus on the simplest generator (documentation). The other generator types may require heavy extension of the "Config" base class, and these docs could very quickly become outdated. When creating a new generator, please review existing generators as a guideline for implementation.

                                                                                                                        Create a new Markdown generator, specifying CommonMark as the name to avoid conflicting with the built-in Markdown generator.

                                                                                                                        ./new.sh -n common-mark -d

                                                                                                                        You should see output similar to the following:

                                                                                                                        Creating modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CommonMarkDocumentationCodegen.java
                                                                                                                        Creating modules/openapi-generator/src/main/resources/common-mark-documentation/README.mustache
                                                                                                                        Creating modules/openapi-generator/src/main/resources/common-mark-documentation/model.mustache
                                                                                                                        Creating modules/openapi-generator/src/main/resources/common-mark-documentation/api.mustache
                                                                                                                        Creating bin/windows/common-mark-documentation-petstore.bat
                                                                                                                        Creating bin/common-mark-documentation-petstore.sh
                                                                                                                        Finished.

                                                                                                                        Review Generated Config

                                                                                                                        Beginning with the "Codegen" file (CommonMarkDocumentationCodegen.java), the constructor was created:

                                                                                                                        public CommonMarkDocumentationCodegen() {
                                                                                                                                super();
                                                                                                                                outputFolder = "generated-code" + File.separator + "common-mark";
                                                                                                                                modelTemplateFiles.put("model.mustache", ".zz");
                                                                                                                                apiTemplateFiles.put("api.mustache", ".zz");
                                                                                                                                embeddedTemplateDir = templateDir = "common-mark-documentation";
                                                                                                                                apiPackage = File.separator + "Apis";
                                                                                                                                modelPackage = File.separator + "Models";
                                                                                                                                supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
                                                                                                                                // TODO: Fill this out.
                                                                                                                            }

                                                                                                                        These options are some defaults which may require updating. Let's look line-by-line at the config.

                                                                                                                        outputFolder = "generated-code" + File.separator + "common-mark";

                                                                                                                        This is the default output location. This will be generated-code/common-mark on non-Windows machines and generated-code\common-mark on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.

                                                                                                                        When joining paths, always use File.seperator

                                                                                                                        modelTemplateFiles.put("model.mustache", ".zz");

                                                                                                                        The model.mustache file is registered as the template for model generation. The new.sh script doesn't have a way to know your intended file extension, so we default to a .zz extension. This must be changed (unless your generator's target extension is .zz). For this example, you'd change .zz to .md or .markdown, depending on your preference.

                                                                                                                        This model template registration will use model.mustache to generate a new file for every model defined in your API's specification document.

                                                                                                                        The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                                                        apiTemplateFiles.put("api.mustache", ".zz");

                                                                                                                        This is the template used for generating API related files. Similar to the above model template, you'll want to change .zz to .md or .markdown.

                                                                                                                        The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                                                        embeddedTemplateDir = templateDir = "common-mark-documentation";

                                                                                                                        This line sets the embedded and template directories to common-mark-documentation. The embeddedTemplateDir refers to the directory which will exist under modules/openapi-generator/src/main/resources and will be published with every release in which your new generator is present.

                                                                                                                        The templateDir variable refers to the "current" template directory setting, as defined by the user. That is, the user may invoke with -t or --template-directory (or plugin option variants), and override this directory.

                                                                                                                        Both of these variables exist because the generator will fallback to files under embeddedTemplateDir if they are not defined in the user's custom template directory.

                                                                                                                        apiPackage = File.separator + "Apis";

                                                                                                                        This sets the "package" location for anything considered an API document. You might want to change this setting if, for instance, your language doesn't support uppercase letters in the path. We don't need to worry about that here.

                                                                                                                        Every templated output from api.mustache (registered via apiTemplateFiles above) will end up in the directory defined by apiPackage here.

                                                                                                                        modelPackage = File.separator + "Models";

                                                                                                                        Similarly, this sets the package for Models.

                                                                                                                        Every templated output from model.mustache (registered via modelTemplateFiles above) will end up in the directory defined by modelPackage here.

                                                                                                                        supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));

                                                                                                                        A "supporting file" is an extra file which isn't created once for every operation or model defined in your specification document. It is a single file which may or may not be templated (determined by the extension of the filename).

                                                                                                                        A supporting file only passes through the Mustache template processor if the filename ends in .mustache.

                                                                                                                        The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                                                        If you want your readme to be generic (not templated), just rename the file to README.md and change README.mustache to README.md above.

                                                                                                                        Create templates

                                                                                                                        The new.sh created our three required files. Let's start filling out each of these files.

                                                                                                                        README.mustache

                                                                                                                        # Documentation for {{appName}}
                                                                                                                        {{#generateApiDocs}}
                                                                                                                        <a name="documentation-for-api-endpoints"></a>
                                                                                                                        ## Documentation for API Endpoints
                                                                                                                        All URIs are relative to *{{{basePath}}}*
                                                                                                                        Class | Method | HTTP request | Description
                                                                                                                        ------------ | ------------- | ------------- | -------------
                                                                                                                        {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
                                                                                                                        {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
                                                                                                                        {{/generateApiDocs}}
                                                                                                                        {{#generateModelDocs}}
                                                                                                                        <a name="documentation-for-models"></a>
                                                                                                                        ## Documentation for Models
                                                                                                                        {{#modelPackage}}
                                                                                                                        {{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)
                                                                                                                        {{/model}}{{/models}}
                                                                                                                        {{/modelPackage}}
                                                                                                                        {{^modelPackage}}
                                                                                                                        No model defined in this package
                                                                                                                        {{/modelPackage}}
                                                                                                                        {{/generateModelDocs}}
                                                                                                                        <a name="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
                                                                                                                        ## Documentation for Authorization
                                                                                                                        {{^authMethods}}
                                                                                                                        All endpoints do not require authorization.
                                                                                                                        {{/authMethods}}
                                                                                                                        {{#authMethods}}
                                                                                                                        {{#last}}
                                                                                                                        Authentication schemes defined for the API:
                                                                                                                        {{/last}}
                                                                                                                        {{/authMethods}}
                                                                                                                        {{#authMethods}}
                                                                                                                        <a name="{{name}}"></a>
                                                                                                                        ### {{name}}
                                                                                                                        {{#isApiKey}}- **Type**: API key
                                                                                                                        - **API key parameter name**: {{keyParamName}}
                                                                                                                        - **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
                                                                                                                        {{/isApiKey}}
                                                                                                                        {{#isBasic}}- **Type**: HTTP basic authentication
                                                                                                                        {{/isBasic}}
                                                                                                                        {{#isOAuth}}- **Type**: OAuth
                                                                                                                        - **Flow**: {{flow}}
                                                                                                                        - **Authorization URL**: {{authorizationUrl}}
                                                                                                                        - **Scopes**: {{^scopes}}N/A{{/scopes}}
                                                                                                                        {{#scopes}}  - {{scope}}: {{description}}
                                                                                                                        {{/scopes}}
                                                                                                                        {{/isOAuth}}
                                                                                                                        {{/authMethods}}

                                                                                                                        Let's not focus too much on the contents of this file. You may refer to templating for more details on the variables bound to these files and to debugging how to debug the structures. Of note here is that we're generating structures in markdown as defined by the objects constructed by our new "Config" class.

                                                                                                                        api.mustache

                                                                                                                        The API documentation might look like this:

                                                                                                                        # {{classname}}{{#description}}
                                                                                                                        {{description}}{{/description}}
                                                                                                                        All URIs are relative to *{{basePath}}*
                                                                                                                        Method | HTTP request | Description
                                                                                                                        ------------- | ------------- | -------------
                                                                                                                        {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
                                                                                                                        {{/operation}}{{/operations}}
                                                                                                                        {{#operations}}
                                                                                                                        {{#operation}}
                                                                                                                        <a name="{{operationId}}"></a>
                                                                                                                        # **{{operationId}}**
                                                                                                                        > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
                                                                                                                        {{summary}}{{#notes}}
                                                                                                                        {{notes}}{{/notes}}
                                                                                                                        ### Parameters
                                                                                                                        {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
                                                                                                                        Name | Type | Description  | Notes
                                                                                                                        ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
                                                                                                                        {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}
                                                                                                                        {{/allParams}}
                                                                                                                        ### Return type
                                                                                                                        {{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}
                                                                                                                        ### Authorization
                                                                                                                        {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}
                                                                                                                        ### HTTP request headers
                                                                                                                         - **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
                                                                                                                         - **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
                                                                                                                        {{/operation}}
                                                                                                                        {{/operations}}

                                                                                                                        model.mustache

                                                                                                                        The models file could resemble the following.

                                                                                                                        {{#models}}
                                                                                                                        {{#model}}
                                                                                                                        # {{{packageName}}}.{{modelPackage}}.{{{classname}}}
                                                                                                                        ## Properties
                                                                                                                        Name | Type | Description | Notes
                                                                                                                        ------------ | ------------- | ------------- | -------------
                                                                                                                        {{#parent}}
                                                                                                                        {{#parentVars}}
                                                                                                                        **{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
                                                                                                                        {{/parentVars}}
                                                                                                                        {{/parent}}
                                                                                                                        {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
                                                                                                                        {{/vars}}
                                                                                                                        [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
                                                                                                                        {{/model}}
                                                                                                                        {{/models}}

                                                                                                                        Build it

                                                                                                                        To compile quickly to test this out, you can run mvn clean package -DskipTests.

                                                                                                                        When implementing a more robust generator, you'll want to run all tests as well: mvn clean package

                                                                                                                        Compile Sample

                                                                                                                        The new.sh script created bin/common-mark-documentation-petstore.sh:

                                                                                                                        #!/bin/sh
                                                                                                                        SCRIPT="$0"
                                                                                                                        while [ -h "$SCRIPT" ] ; do
                                                                                                                          ls=$(ls -ld "$SCRIPT")
                                                                                                                          link=$(expr "$ls" : '.*-> \(.*\)$')
                                                                                                                          if expr "$link" : '/.*' > /dev/null; then
                                                                                                                            SCRIPT="$link"
                                                                                                                          else
                                                                                                                            SCRIPT=$(dirname "$SCRIPT")/"$link"
                                                                                                                          fi
                                                                                                                        done
                                                                                                                        if [ ! -d "${APP_DIR}" ]; then
                                                                                                                          APP_DIR=$(dirname "$SCRIPT")/..
                                                                                                                          APP_DIR=$(cd "${APP_DIR}"; pwd)
                                                                                                                        fi
                                                                                                                        executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
                                                                                                                        if [ ! -f "$executable" ]
                                                                                                                        then
                                                                                                                          mvn clean package
                                                                                                                        fi
                                                                                                                        # if you've executed sbt assembly previously it will use that instead.
                                                                                                                        export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
                                                                                                                        ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/mark"
                                                                                                                        java ${JAVA_OPTS} -jar ${executable} ${ags}

                                                                                                                        This script is often used to apply default options for generation. A common option in most of these script is to define the template directory as the generator's directory under resources. This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a CliOption).

                                                                                                                        Add -t modules/openapi-generator/src/main/resources/common-mark-documentation to ags line to simplify the evaluation of template-only modifications:

                                                                                                                        diff --git a/bin/markdown-documentation-petstore.sh b/bin/markdown-documentation-petstore.sh
                                                                                                                        index d816771478..94b4ce6d12 100644
                                                                                                                        --- a/bin/markdown-documentation-petstore.sh
                                                                                                                        +++ b/bin/markdown-documentation-petstore.sh
                                                                                                                        @@ -26,6 +26,6 @@ fi
                                                                                                                         # if you've executed sbt assembly previously it will use that instead.
                                                                                                                         export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
                                                                                                                        -ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common-mark"
                                                                                                                        +ags="$@ generate -t modules/openapi-generator/src/main/resources/common-mark-documentation -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/markdown"
                                                                                                                         java ${JAVA_OPTS} -jar ${executable} ${ags}

                                                                                                                        Verify output

                                                                                                                        Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works.

                                                                                                                        For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install markserv:

                                                                                                                        npm install --global markserv

                                                                                                                        Now, you can serve the output directory directly and test your links:

                                                                                                                        markserv samples/documentation/petstore/common/markdown

                                                                                                                        That's it! You've created your first generator!

                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +

                                                                                                                        Create a New Generator

                                                                                                                        Creating a new generator which will become a part of the officially supported generators in OpenAPI Generator is pretty simple. We've created a helper script to bootstrap the operation. Let's look at the files necessary to create a new generator, then an example of bootstrapping a generator using the new.sh script in the root of the repository.

                                                                                                                        Required Files

                                                                                                                        The minimum set of files required to create a new generator are:

                                                                                                                        • A "Codegen" file
                                                                                                                          • exists under modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/
                                                                                                                          • defines language options
                                                                                                                          • defines framework options
                                                                                                                          • determines OpenAPI feature set
                                                                                                                          • extends the generation workflow
                                                                                                                        • SPI registration
                                                                                                                          • Above class must be referenced in modules/openapi-generator/src/main/resources/META-INF/services/org.openapitools.codegen.CodegenConfig
                                                                                                                          • Tells the generator that this class exists
                                                                                                                          • Allows for classpath extension (addition) of generators
                                                                                                                        • A minimal template
                                                                                                                          • Should include a README explaining usage
                                                                                                                          • Must include an api.mustache
                                                                                                                          • Exists under modules/openapi-generator/src/main/resources/ (plus embeddedTemplate dir value, see below)
                                                                                                                        • Sample scripts under ./bin and ./bin/windows
                                                                                                                          • Gives users a "real life" example of generated output
                                                                                                                          • Samples are used by CI to verify generators and test for regressions in some cases

                                                                                                                        Now, let's generate an example generator and then walk through the pieces. At the end, we'll touch on some known sticking points for new generator authors and provide some suggestions.

                                                                                                                        new.sh

                                                                                                                        The new.sh script in the root of the project is meant to simplify this process. Run ./new.sh --help.

                                                                                                                        Stubs out files for new generators
                                                                                                                        Usage:
                                                                                                                        ./new.sh [options]
                                                                                                                            Options:
                                                                                                                            -n  Required. Specify generator name, should be kebab-cased.
                                                                                                                            -c  Create a client generator
                                                                                                                            -s  Create a server generator
                                                                                                                            -d  Create a documentation generator
                                                                                                                            -t  When specified, creates test file(s) for the generator.
                                                                                                                            -h  Display help.
                                                                                                                        Examples:
                                                                                                                          Create a server generator for ktor:
                                                                                                                          ./new.sh -n kotlin -s
                                                                                                                            Creates:
                                                                                                                            modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinServerCodegen.java
                                                                                                                            modules/openapi-generator/src/main/resources/kotlin-server/README.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/kotlin-server/model.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/kotlin-server/api.mustache
                                                                                                                            bin/windows/kotlin-server-petstore.bat
                                                                                                                            bin/kotlin-server-petstore.sh
                                                                                                                          Create a generic C# server generator:
                                                                                                                          ./new.sh -n csharp -s -t
                                                                                                                            Creates:
                                                                                                                            modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CsharpServerCodegen.java
                                                                                                                            modules/openapi-generator/src/main/resources/csharp-server/README.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/csharp-server/model.mustache
                                                                                                                            modules/openapi-generator/src/main/resources/csharp-server/api.mustache
                                                                                                                            bin/windows/csharp-server-petstore.bat
                                                                                                                            bin/csharp-server-petstore.sh
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenTest.java
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenModelTest.java
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/csharp/CsharpServerCodegenOptionsTest.java
                                                                                                                            modules/openapi-generator/src/test/java/org/openapitools/codegen/options/CsharpServerCodegenOptionsProvider.java

                                                                                                                        This script allows us to define a client, server, schema, or documentation generator. We'll focus on the simplest generator (documentation). The other generator types may require heavy extension of the "Config" base class, and these docs could very quickly become outdated. When creating a new generator, please review existing generators as a guideline for implementation.

                                                                                                                        Create a new Markdown generator, specifying CommonMark as the name to avoid conflicting with the built-in Markdown generator.

                                                                                                                        ./new.sh -n common-mark -d

                                                                                                                        You should see output similar to the following:

                                                                                                                        Creating modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/CommonMarkDocumentationCodegen.java
                                                                                                                        Creating modules/openapi-generator/src/main/resources/common-mark-documentation/README.mustache
                                                                                                                        Creating modules/openapi-generator/src/main/resources/common-mark-documentation/model.mustache
                                                                                                                        Creating modules/openapi-generator/src/main/resources/common-mark-documentation/api.mustache
                                                                                                                        Creating bin/windows/common-mark-documentation-petstore.bat
                                                                                                                        Creating bin/common-mark-documentation-petstore.sh
                                                                                                                        Finished.

                                                                                                                        Review Generated Config

                                                                                                                        Beginning with the "Codegen" file (CommonMarkDocumentationCodegen.java), the constructor was created:

                                                                                                                        public CommonMarkDocumentationCodegen() {
                                                                                                                                super();
                                                                                                                                outputFolder = "generated-code" + File.separator + "common-mark";
                                                                                                                                modelTemplateFiles.put("model.mustache", ".zz");
                                                                                                                                apiTemplateFiles.put("api.mustache", ".zz");
                                                                                                                                embeddedTemplateDir = templateDir = "common-mark-documentation";
                                                                                                                                apiPackage = File.separator + "Apis";
                                                                                                                                modelPackage = File.separator + "Models";
                                                                                                                                supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));
                                                                                                                                // TODO: Fill this out.
                                                                                                                            }

                                                                                                                        These options are some defaults which may require updating. Let's look line-by-line at the config.

                                                                                                                        outputFolder = "generated-code" + File.separator + "common-mark";

                                                                                                                        This is the default output location. This will be generated-code/common-mark on non-Windows machines and generated-code\common-mark on Windows. You may change this to any value you'd like, but a user will almost always provide an output directory.

                                                                                                                        When joining paths, always use File.seperator

                                                                                                                        modelTemplateFiles.put("model.mustache", ".zz");

                                                                                                                        The model.mustache file is registered as the template for model generation. The new.sh script doesn't have a way to know your intended file extension, so we default to a .zz extension. This must be changed (unless your generator's target extension is .zz). For this example, you'd change .zz to .md or .markdown, depending on your preference.

                                                                                                                        This model template registration will use model.mustache to generate a new file for every model defined in your API's specification document.

                                                                                                                        The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                                                        apiTemplateFiles.put("api.mustache", ".zz");

                                                                                                                        This is the template used for generating API related files. Similar to the above model template, you'll want to change .zz to .md or .markdown.

                                                                                                                        The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                                                        embeddedTemplateDir = templateDir = "common-mark-documentation";

                                                                                                                        This line sets the embedded and template directories to common-mark-documentation. The embeddedTemplateDir refers to the directory which will exist under modules/openapi-generator/src/main/resources and will be published with every release in which your new generator is present.

                                                                                                                        The templateDir variable refers to the "current" template directory setting, as defined by the user. That is, the user may invoke with -t or --template-directory (or plugin option variants), and override this directory.

                                                                                                                        Both of these variables exist because the generator will fallback to files under embeddedTemplateDir if they are not defined in the user's custom template directory.

                                                                                                                        apiPackage = File.separator + "Apis";

                                                                                                                        This sets the "package" location for anything considered an API document. You might want to change this setting if, for instance, your language doesn't support uppercase letters in the path. We don't need to worry about that here.

                                                                                                                        Every templated output from api.mustache (registered via apiTemplateFiles above) will end up in the directory defined by apiPackage here.

                                                                                                                        modelPackage = File.separator + "Models";

                                                                                                                        Similarly, this sets the package for Models.

                                                                                                                        Every templated output from model.mustache (registered via modelTemplateFiles above) will end up in the directory defined by modelPackage here.

                                                                                                                        supportingFiles.add(new SupportingFile("README.mustache", "", "README.md"));

                                                                                                                        A "supporting file" is an extra file which isn't created once for every operation or model defined in your specification document. It is a single file which may or may not be templated (determined by the extension of the filename).

                                                                                                                        A supporting file only passes through the Mustache template processor if the filename ends in .mustache.

                                                                                                                        The path is considered relative to embeddedTemplateDir, templateDir, or a library subdirectory (refer to the Java client generator implementation for a prime example).

                                                                                                                        If you want your readme to be generic (not templated), just rename the file to README.md and change README.mustache to README.md above.

                                                                                                                        Create templates

                                                                                                                        The new.sh created our three required files. Let's start filling out each of these files.

                                                                                                                        README.mustache

                                                                                                                        # Documentation for {{appName}}
                                                                                                                        {{#generateApiDocs}}
                                                                                                                        <a name="documentation-for-api-endpoints"></a>
                                                                                                                        ## Documentation for API Endpoints
                                                                                                                        All URIs are relative to *{{{basePath}}}*
                                                                                                                        Class | Method | HTTP request | Description
                                                                                                                        ------------ | ------------- | ------------- | -------------
                                                                                                                        {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**](Apis/{{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}
                                                                                                                        {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
                                                                                                                        {{/generateApiDocs}}
                                                                                                                        {{#generateModelDocs}}
                                                                                                                        <a name="documentation-for-models"></a>
                                                                                                                        ## Documentation for Models
                                                                                                                        {{#modelPackage}}
                                                                                                                        {{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}](Models/{{modelDocPath}}{{{classname}}}.md)
                                                                                                                        {{/model}}{{/models}}
                                                                                                                        {{/modelPackage}}
                                                                                                                        {{^modelPackage}}
                                                                                                                        No model defined in this package
                                                                                                                        {{/modelPackage}}
                                                                                                                        {{/generateModelDocs}}
                                                                                                                        <a name="documentation-for-authorization"></a>{{! TODO: optional documentation for authorization? }}
                                                                                                                        ## Documentation for Authorization
                                                                                                                        {{^authMethods}}
                                                                                                                        All endpoints do not require authorization.
                                                                                                                        {{/authMethods}}
                                                                                                                        {{#authMethods}}
                                                                                                                        {{#last}}
                                                                                                                        Authentication schemes defined for the API:
                                                                                                                        {{/last}}
                                                                                                                        {{/authMethods}}
                                                                                                                        {{#authMethods}}
                                                                                                                        <a name="{{name}}"></a>
                                                                                                                        ### {{name}}
                                                                                                                        {{#isApiKey}}- **Type**: API key
                                                                                                                        - **API key parameter name**: {{keyParamName}}
                                                                                                                        - **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
                                                                                                                        {{/isApiKey}}
                                                                                                                        {{#isBasic}}- **Type**: HTTP basic authentication
                                                                                                                        {{/isBasic}}
                                                                                                                        {{#isOAuth}}- **Type**: OAuth
                                                                                                                        - **Flow**: {{flow}}
                                                                                                                        - **Authorization URL**: {{authorizationUrl}}
                                                                                                                        - **Scopes**: {{^scopes}}N/A{{/scopes}}
                                                                                                                        {{#scopes}}  - {{scope}}: {{description}}
                                                                                                                        {{/scopes}}
                                                                                                                        {{/isOAuth}}
                                                                                                                        {{/authMethods}}

                                                                                                                        Let's not focus too much on the contents of this file. You may refer to templating for more details on the variables bound to these files and to debugging how to debug the structures. Of note here is that we're generating structures in markdown as defined by the objects constructed by our new "Config" class.

                                                                                                                        api.mustache

                                                                                                                        The API documentation might look like this:

                                                                                                                        # {{classname}}{{#description}}
                                                                                                                        {{description}}{{/description}}
                                                                                                                        All URIs are relative to *{{basePath}}*
                                                                                                                        Method | HTTP request | Description
                                                                                                                        ------------- | ------------- | -------------
                                                                                                                        {{#operations}}{{#operation}}[**{{operationId}}**]({{classname}}.md#{{operationId}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
                                                                                                                        {{/operation}}{{/operations}}
                                                                                                                        {{#operations}}
                                                                                                                        {{#operation}}
                                                                                                                        <a name="{{operationId}}"></a>
                                                                                                                        # **{{operationId}}**
                                                                                                                        > {{#returnType}}{{returnType}} {{/returnType}}{{operationId}}({{#allParams}}{{{paramName}}}{{#hasMore}}, {{/hasMore}}{{/allParams}})
                                                                                                                        {{summary}}{{#notes}}
                                                                                                                        {{notes}}{{/notes}}
                                                                                                                        ### Parameters
                                                                                                                        {{^allParams}}This endpoint does not need any parameter.{{/allParams}}{{#allParams}}{{#-last}}
                                                                                                                        Name | Type | Description  | Notes
                                                                                                                        ------------- | ------------- | ------------- | -------------{{/-last}}{{/allParams}}
                                                                                                                        {{#allParams}} **{{paramName}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}{{#isFile}}**{{dataType}}**{{/isFile}}{{^isFile}}{{#generateModelDocs}}[**{{dataType}}**]({{baseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{dataType}}**{{/generateModelDocs}}{{/isFile}}{{/isPrimitiveType}}| {{description}} |{{^required}} [optional]{{/required}}{{#defaultValue}} [default to {{defaultValue}}]{{/defaultValue}}{{#allowableValues}} [enum: {{#values}}{{{.}}}{{^-last}}, {{/-last}}{{/values}}]{{/allowableValues}}
                                                                                                                        {{/allParams}}
                                                                                                                        ### Return type
                                                                                                                        {{#returnType}}{{#returnTypeIsPrimitive}}**{{returnType}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}{{#generateModelDocs}}[**{{returnType}}**]({{returnBaseType}}.md){{/generateModelDocs}}{{^generateModelDocs}}**{{returnType}}**{{/generateModelDocs}}{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}null (empty response body){{/returnType}}
                                                                                                                        ### Authorization
                                                                                                                        {{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{name}}](../README.md#{{name}}){{^-last}}, {{/-last}}{{/authMethods}}
                                                                                                                        ### HTTP request headers
                                                                                                                         - **Content-Type**: {{#consumes}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
                                                                                                                         - **Accept**: {{#produces}}{{{mediaType}}}{{#hasMore}}, {{/hasMore}}{{/produces}}{{^produces}}Not defined{{/produces}}
                                                                                                                        {{/operation}}
                                                                                                                        {{/operations}}

                                                                                                                        model.mustache

                                                                                                                        The models file could resemble the following.

                                                                                                                        {{#models}}
                                                                                                                        {{#model}}
                                                                                                                        # {{{packageName}}}.{{modelPackage}}.{{{classname}}}
                                                                                                                        ## Properties
                                                                                                                        Name | Type | Description | Notes
                                                                                                                        ------------ | ------------- | ------------- | -------------
                                                                                                                        {{#parent}}
                                                                                                                        {{#parentVars}}
                                                                                                                        **{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
                                                                                                                        {{/parentVars}}
                                                                                                                        {{/parent}}
                                                                                                                        {{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#readOnly}}[readonly] {{/readOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
                                                                                                                        {{/vars}}
                                                                                                                        [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
                                                                                                                        {{/model}}
                                                                                                                        {{/models}}

                                                                                                                        Build it

                                                                                                                        To compile quickly to test this out, you can run mvn clean package -DskipTests.

                                                                                                                        When implementing a more robust generator, you'll want to run all tests as well: mvn clean package

                                                                                                                        Compile Sample

                                                                                                                        The new.sh script created bin/common-mark-documentation-petstore.sh:

                                                                                                                        #!/bin/sh
                                                                                                                        SCRIPT="$0"
                                                                                                                        while [ -h "$SCRIPT" ] ; do
                                                                                                                          ls=$(ls -ld "$SCRIPT")
                                                                                                                          link=$(expr "$ls" : '.*-> \(.*\)$')
                                                                                                                          if expr "$link" : '/.*' > /dev/null; then
                                                                                                                            SCRIPT="$link"
                                                                                                                          else
                                                                                                                            SCRIPT=$(dirname "$SCRIPT")/"$link"
                                                                                                                          fi
                                                                                                                        done
                                                                                                                        if [ ! -d "${APP_DIR}" ]; then
                                                                                                                          APP_DIR=$(dirname "$SCRIPT")/..
                                                                                                                          APP_DIR=$(cd "${APP_DIR}"; pwd)
                                                                                                                        fi
                                                                                                                        executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
                                                                                                                        if [ ! -f "$executable" ]
                                                                                                                        then
                                                                                                                          mvn clean package
                                                                                                                        fi
                                                                                                                        # if you've executed sbt assembly previously it will use that instead.
                                                                                                                        export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
                                                                                                                        ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/mark"
                                                                                                                        java ${JAVA_OPTS} -jar ${executable} ${ags}

                                                                                                                        This script is often used to apply default options for generation. A common option in most of these script is to define the template directory as the generator's directory under resources. This allows template maintainers to modify and test out template changes which don't require recompilation of the entire project. You'd still need to recompile the project in full if you add or modify behaviors to the generator (such as adding a CliOption).

                                                                                                                        Add -t modules/openapi-generator/src/main/resources/common-mark-documentation to ags line to simplify the evaluation of template-only modifications:

                                                                                                                        diff --git a/bin/markdown-documentation-petstore.sh b/bin/markdown-documentation-petstore.sh
                                                                                                                        index d816771478..94b4ce6d12 100644
                                                                                                                        --- a/bin/markdown-documentation-petstore.sh
                                                                                                                        +++ b/bin/markdown-documentation-petstore.sh
                                                                                                                        @@ -26,6 +26,6 @@ fi
                                                                                                                         # if you've executed sbt assembly previously it will use that instead.
                                                                                                                         export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
                                                                                                                        -ags="$@ generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common-mark"
                                                                                                                        +ags="$@ generate -t modules/openapi-generator/src/main/resources/common-mark-documentation -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g common-mark -o samples/documentation/petstore/common/markdown"
                                                                                                                         java ${JAVA_OPTS} -jar ${executable} ${ags}

                                                                                                                        Verify output

                                                                                                                        Creating a new generator will be an iterative task. Once you've generated the sample, you'll want to try it out. For compiled client/server outputs, this would mean running the code or creating a small sample project to consume your artifact just to make sure it works.

                                                                                                                        For markdown, you can open in Visual Studio Code or any other editor with a markdown preview. Not all editors support relative links to other markdown documents. To test the output in this guide, install markserv:

                                                                                                                        npm install --global markserv

                                                                                                                        Now, you can serve the output directory directly and test your links:

                                                                                                                        markserv samples/documentation/petstore/common/markdown

                                                                                                                        That's it! You've created your first generator!

                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/online/index.html b/docs/online/index.html index 7cb41c75a12..94e6911ce1d 100644 --- a/docs/online/index.html +++ b/docs/online/index.html @@ -21,33 +21,33 @@ - +

                                                                                                                        Online

                                                                                                                        Hosted

                                                                                                                        We offer online services, publicly and free of charge:

                                                                                                                        Hosting Sponsor
                                                                                                                        -Linode Logo

                                                                                                                        These services are beta and do not have any guarantee on service level

                                                                                                                        Docker Image

                                                                                                                        The openapi-generator-online Docker image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.

                                                                                                                        Example usage:

                                                                                                                        # Start container at port 8888 and save the container id
                                                                                                                        CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online)
                                                                                                                        # allow for startup
                                                                                                                        sleep 10
                                                                                                                        # Get the IP of the running container (optional)
                                                                                                                        GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'  ${CID})
                                                                                                                        # Execute an HTTP request to generate a Ruby client
                                                                                                                        curl -X POST --header 'Content-Type: application/json' \
                                                                                                                          --header 'Accept: application/json' \
                                                                                                                          -d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
                                                                                                                          'http://localhost:8888/api/gen/clients/ruby'
                                                                                                                        # Example output:
                                                                                                                        # {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}
                                                                                                                        # Download the generated zip file  (using "code" provided from your output) 
                                                                                                                        wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8
                                                                                                                        # Unzip the file
                                                                                                                        unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8
                                                                                                                        # Shutdown the openapi generator image
                                                                                                                        docker stop ${CID} && docker rm ${CID}

                                                                                                                        Local/Self-hosting

                                                                                                                        If you prefer to run the service locally, here are the steps:

                                                                                                                        mvn clean install
                                                                                                                        cd modules/openapi-generator-online
                                                                                                                        mvn spring-boot:run

                                                                                                                        The online openapi-generator can be run via Docker as well.

                                                                                                                        For example, to generate Ruby API client, simply send the following HTTP request using curl:

                                                                                                                        curl -X POST -H "content-type:application/json" -d '{"openAPIUrl":"https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
                                                                                                                            http://localhost:8080/api/gen/clients/ruby

                                                                                                                        Then you will receive a JSON response with the URL to download the zipped code.

                                                                                                                        To customize the SDK, you can POST to http://localhost:8080/gen/clients/{generator} with the following HTTP body:

                                                                                                                        {
                                                                                                                          "options": {},
                                                                                                                          "openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"
                                                                                                                        }

                                                                                                                        Here, the options for a language can be obtained by submitting a GET request to http://locahost:8080/api/gen/clients/{generator}:

                                                                                                                        For example, curl http://localhost:8080/api/gen/clients/python returns

                                                                                                                        "packageName":{
                                                                                                                            "opt":"packageName",
                                                                                                                            "description":"python package name (convention: snake_case).",
                                                                                                                            "type":"string",
                                                                                                                            "default":"openapi_client"
                                                                                                                          },
                                                                                                                          "packageVersion":{
                                                                                                                            "opt":"packageVersion",
                                                                                                                            "description":"python package version.",
                                                                                                                            "type":"string",
                                                                                                                            "default":"1.0.0"
                                                                                                                          },
                                                                                                                          "sortParamsByRequiredFlag":{
                                                                                                                            "opt":"sortParamsByRequiredFlag",
                                                                                                                            "description":"Sort method arguments to place required parameters before optional parameters.",
                                                                                                                            "type":"boolean",
                                                                                                                            "default":"true"
                                                                                                                          }
                                                                                                                        {}

                                                                                                                        To set package name to pet_store, the HTTP body of the request is as follows:

                                                                                                                        {
                                                                                                                          "options": {
                                                                                                                            "packageName": "pet_store"
                                                                                                                          },
                                                                                                                          "openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"
                                                                                                                        }

                                                                                                                        and here is the curl command:

                                                                                                                        curl -H "Content-type: application/json" \
                                                                                                                            -X POST \
                                                                                                                            -d '{"options": {"packageName": "pet_store"},"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
                                                                                                                            http://localhost:8080/api/gen/clients/python

                                                                                                                        Instead of using openAPIUrl with an URL to the OpenAPI spec, one can include the spec in the JSON payload with spec:

                                                                                                                        {
                                                                                                                          "options": {},
                                                                                                                          "spec": {
                                                                                                                            "swagger": "2.0",
                                                                                                                            "info": {
                                                                                                                              "version": "1.0.0",
                                                                                                                              "title": "Test API"
                                                                                                                            },
                                                                                                                            ...
                                                                                                                          }
                                                                                                                        }
                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +Linode Logo

                                                                                                                        These services are beta and do not have any guarantee on service level

                                                                                                                        Docker Image

                                                                                                                        The openapi-generator-online Docker image can act as a self-hosted web application and API for generating code. This container can be incorporated into a CI pipeline, and requires at least two HTTP requests and some docker orchestration to access generated code.

                                                                                                                        Example usage:

                                                                                                                        # Start container at port 8888 and save the container id
                                                                                                                        CID=$(docker run -d -p 8888:8080 openapitools/openapi-generator-online)
                                                                                                                        # allow for startup
                                                                                                                        sleep 10
                                                                                                                        # Get the IP of the running container (optional)
                                                                                                                        GEN_IP=$(docker inspect --format '{{.NetworkSettings.IPAddress}}'  ${CID})
                                                                                                                        # Execute an HTTP request to generate a Ruby client
                                                                                                                        curl -X POST --header 'Content-Type: application/json' \
                                                                                                                          --header 'Accept: application/json' \
                                                                                                                          -d '{"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
                                                                                                                          'http://localhost:8888/api/gen/clients/ruby'
                                                                                                                        # Example output:
                                                                                                                        # {"code":"c2d483.3.4672-40e9-91df-b9ffd18d22b8","link":"http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8"}
                                                                                                                        # Download the generated zip file  (using "code" provided from your output) 
                                                                                                                        wget http://localhost:8888/api/gen/download/c2d483.3.4672-40e9-91df-b9ffd18d22b8
                                                                                                                        # Unzip the file
                                                                                                                        unzip c2d483.3.4672-40e9-91df-b9ffd18d22b8
                                                                                                                        # Shutdown the openapi generator image
                                                                                                                        docker stop ${CID} && docker rm ${CID}

                                                                                                                        Local/Self-hosting

                                                                                                                        If you prefer to run the service locally, here are the steps:

                                                                                                                        mvn clean install
                                                                                                                        cd modules/openapi-generator-online
                                                                                                                        mvn spring-boot:run

                                                                                                                        The online openapi-generator can be run via Docker as well.

                                                                                                                        For example, to generate Ruby API client, simply send the following HTTP request using curl:

                                                                                                                        curl -X POST -H "content-type:application/json" -d '{"openAPIUrl":"https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
                                                                                                                            http://localhost:8080/api/gen/clients/ruby

                                                                                                                        Then you will receive a JSON response with the URL to download the zipped code.

                                                                                                                        To customize the SDK, you can POST to http://localhost:8080/gen/clients/{generator} with the following HTTP body:

                                                                                                                        {
                                                                                                                          "options": {},
                                                                                                                          "openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"
                                                                                                                        }

                                                                                                                        Here, the options for a language can be obtained by submitting a GET request to http://locahost:8080/api/gen/clients/{generator}:

                                                                                                                        For example, curl http://localhost:8080/api/gen/clients/python returns

                                                                                                                        "packageName":{
                                                                                                                            "opt":"packageName",
                                                                                                                            "description":"python package name (convention: snake_case).",
                                                                                                                            "type":"string",
                                                                                                                            "default":"openapi_client"
                                                                                                                          },
                                                                                                                          "packageVersion":{
                                                                                                                            "opt":"packageVersion",
                                                                                                                            "description":"python package version.",
                                                                                                                            "type":"string",
                                                                                                                            "default":"1.0.0"
                                                                                                                          },
                                                                                                                          "sortParamsByRequiredFlag":{
                                                                                                                            "opt":"sortParamsByRequiredFlag",
                                                                                                                            "description":"Sort method arguments to place required parameters before optional parameters.",
                                                                                                                            "type":"boolean",
                                                                                                                            "default":"true"
                                                                                                                          }
                                                                                                                        {}

                                                                                                                        To set package name to pet_store, the HTTP body of the request is as follows:

                                                                                                                        {
                                                                                                                          "options": {
                                                                                                                            "packageName": "pet_store"
                                                                                                                          },
                                                                                                                          "openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"
                                                                                                                        }

                                                                                                                        and here is the curl command:

                                                                                                                        curl -H "Content-type: application/json" \
                                                                                                                            -X POST \
                                                                                                                            -d '{"options": {"packageName": "pet_store"},"openAPIUrl": "https://raw.githubusercontent.com/openapitools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml"}' \
                                                                                                                            http://localhost:8080/api/gen/clients/python

                                                                                                                        Instead of using openAPIUrl with an URL to the OpenAPI spec, one can include the spec in the JSON payload with spec:

                                                                                                                        {
                                                                                                                          "options": {},
                                                                                                                          "spec": {
                                                                                                                            "swagger": "2.0",
                                                                                                                            "info": {
                                                                                                                              "version": "1.0.0",
                                                                                                                              "title": "Test API"
                                                                                                                            },
                                                                                                                            ...
                                                                                                                          }
                                                                                                                        }
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/plugins/index.html b/docs/plugins/index.html index 5114361f075..a3318b12e71 100644 --- a/docs/plugins/index.html +++ b/docs/plugins/index.html @@ -21,32 +21,32 @@ - +
                                                                                                                        -

                                                                                                                        Plugins

                                                                                                                        Maven

                                                                                                                        A Maven plugin to support the OpenAPI generator project

                                                                                                                        Example

                                                                                                                        Add to your build->plugins section (default phase is generate-sources phase)

                                                                                                                        <plugin>
                                                                                                                            <groupId>org.openapitools</groupId>
                                                                                                                            <artifactId>openapi-generator-maven-plugin</artifactId>
                                                                                                                            <version>3.3.4</version>
                                                                                                                            <executions>
                                                                                                                                <execution>
                                                                                                                                    <goals>
                                                                                                                                        <goal>generate</goal>
                                                                                                                                    </goals>
                                                                                                                                    <configuration>
                                                                                                                                        <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
                                                                                                                                        <generatorName>java</generatorName>
                                                                                                                                        <configOptions>
                                                                                                                                           <sourceFolder>src/gen/java/main</sourceFolder>
                                                                                                                                        </configOptions>
                                                                                                                                    </configuration>
                                                                                                                                </execution>
                                                                                                                            </executions>
                                                                                                                        </plugin>

                                                                                                                        Followed by:

                                                                                                                        mvn clean compile

                                                                                                                        For full details of all options, see the plugin README.

                                                                                                                        Gradle

                                                                                                                        This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you’d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you’re interested in the extension/task mapping concept from a high-level, you can check out Gradle’s docs.

                                                                                                                        To include in your project, add the following to build.gradle:

                                                                                                                        buildscript {
                                                                                                                          repositories {
                                                                                                                            mavenLocal()
                                                                                                                            maven { url "https://repo1.maven.org/maven2" }
                                                                                                                          }
                                                                                                                          dependencies {
                                                                                                                            classpath "org.openapitools:openapi-generator-gradle-plugin:3.3.4"
                                                                                                                          }
                                                                                                                        }
                                                                                                                        apply plugin: 'org.openapi.generator'

                                                                                                                        This gives access to the following tasks:

                                                                                                                        TaskDescription
                                                                                                                        openApiGenerateGenerate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.
                                                                                                                        openApiGeneratorsLists generators available via Open API Generators.
                                                                                                                        openApiMetaGenerates a new generator to be consumed via Open API Generator.
                                                                                                                        openApiValidateValidates an Open API 2.0 or 3.x specification document.

                                                                                                                        The plugin implements the above tasks as project extensions of the same name. If you’d like to declare these tasks as dependencies to other tasks (using dependsOn), you’ll need a task reference. e.g.:

                                                                                                                        compileJava.dependsOn tasks.openApiGenerate

                                                                                                                        For full details of all options, see the plugin README.

                                                                                                                        Example

                                                                                                                        An example task for generating a kotlin client:

                                                                                                                        openApiGenerate {
                                                                                                                            generatorName = "kotlin"
                                                                                                                            inputSpec = "$rootDir/specs/petstore-v3.0.yaml".toString()
                                                                                                                            outputDir = "$buildDir/generated".toString()
                                                                                                                            apiPackage = "org.openapi.example.api"
                                                                                                                            invokerPackage = "org.openapi.example.invoker"
                                                                                                                            modelPackage = "org.openapi.example.model"
                                                                                                                            modelFilesConstrainedTo = [
                                                                                                                                    "Error"
                                                                                                                            ]
                                                                                                                            configOptions = [
                                                                                                                                dateLibrary: "java8"
                                                                                                                            ]
                                                                                                                        }
                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +

                                                                                                                        Plugins

                                                                                                                        Maven

                                                                                                                        A Maven plugin to support the OpenAPI generator project

                                                                                                                        Example

                                                                                                                        Add to your build->plugins section (default phase is generate-sources phase)

                                                                                                                        <plugin>
                                                                                                                            <groupId>org.openapitools</groupId>
                                                                                                                            <artifactId>openapi-generator-maven-plugin</artifactId>
                                                                                                                            <version>3.3.4</version>
                                                                                                                            <executions>
                                                                                                                                <execution>
                                                                                                                                    <goals>
                                                                                                                                        <goal>generate</goal>
                                                                                                                                    </goals>
                                                                                                                                    <configuration>
                                                                                                                                        <inputSpec>${project.basedir}/src/main/resources/api.yaml</inputSpec>
                                                                                                                                        <generatorName>java</generatorName>
                                                                                                                                        <configOptions>
                                                                                                                                           <sourceFolder>src/gen/java/main</sourceFolder>
                                                                                                                                        </configOptions>
                                                                                                                                    </configuration>
                                                                                                                                </execution>
                                                                                                                            </executions>
                                                                                                                        </plugin>

                                                                                                                        Followed by:

                                                                                                                        mvn clean compile

                                                                                                                        For full details of all options, see the plugin README.

                                                                                                                        Gradle

                                                                                                                        This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you’d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you’re interested in the extension/task mapping concept from a high-level, you can check out Gradle’s docs.

                                                                                                                        To include in your project, add the following to build.gradle:

                                                                                                                        buildscript {
                                                                                                                          repositories {
                                                                                                                            mavenLocal()
                                                                                                                            maven { url "https://repo1.maven.org/maven2" }
                                                                                                                          }
                                                                                                                          dependencies {
                                                                                                                            classpath "org.openapitools:openapi-generator-gradle-plugin:3.3.4"
                                                                                                                          }
                                                                                                                        }
                                                                                                                        apply plugin: 'org.openapi.generator'

                                                                                                                        This gives access to the following tasks:

                                                                                                                        TaskDescription
                                                                                                                        openApiGenerateGenerate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.
                                                                                                                        openApiGeneratorsLists generators available via Open API Generators.
                                                                                                                        openApiMetaGenerates a new generator to be consumed via Open API Generator.
                                                                                                                        openApiValidateValidates an Open API 2.0 or 3.x specification document.

                                                                                                                        The plugin implements the above tasks as project extensions of the same name. If you’d like to declare these tasks as dependencies to other tasks (using dependsOn), you’ll need a task reference. e.g.:

                                                                                                                        compileJava.dependsOn tasks.openApiGenerate

                                                                                                                        For full details of all options, see the plugin README.

                                                                                                                        Example

                                                                                                                        An example task for generating a kotlin client:

                                                                                                                        openApiGenerate {
                                                                                                                            generatorName = "kotlin"
                                                                                                                            inputSpec = "$rootDir/specs/petstore-v3.0.yaml".toString()
                                                                                                                            outputDir = "$buildDir/generated".toString()
                                                                                                                            apiPackage = "org.openapi.example.api"
                                                                                                                            invokerPackage = "org.openapi.example.invoker"
                                                                                                                            modelPackage = "org.openapi.example.model"
                                                                                                                            modelFilesConstrainedTo = [
                                                                                                                                    "Error"
                                                                                                                            ]
                                                                                                                            configOptions = [
                                                                                                                                dateLibrary: "java8"
                                                                                                                            ]
                                                                                                                        }
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/release-3-0-0/index.html b/docs/release-3-0-0/index.html index 634d8828b07..c7e3209c99b 100644 --- a/docs/release-3-0-0/index.html +++ b/docs/release-3-0-0/index.html @@ -21,26 +21,26 @@ - +
                                                                                                                        -

                                                                                                                        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
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +

                                                                                                                        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
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/release-summary/index.html b/docs/release-summary/index.html index 3153bf5fa28..47d883a2288 100644 --- a/docs/release-summary/index.html +++ b/docs/release-summary/index.html @@ -21,32 +21,32 @@ - +
                                                                                                                        -

                                                                                                                        Release Summary

                                                                                                                        Versioning

                                                                                                                        We version artifacts in the common major.minor.patch strategy.

                                                                                                                        We decided versions should be incremented according to the following rules. The examples provided below are not exhaustive.

                                                                                                                        PartBreaking Changes?RuleExamples
                                                                                                                        majorYESbreaking changes without fallback
                                                                                                                        • New Features
                                                                                                                        • Large refactors
                                                                                                                        • Removal of deprecated code
                                                                                                                        • Changes to coding interfaces
                                                                                                                        • Large changes to template bound variables
                                                                                                                        minorALLOWEDbreaking changes with fallback
                                                                                                                        • Adding new generator behavior which doesn't affect custom templates (or does, with config option for old behavior)
                                                                                                                        • Changing generator templates in a way in which switching to custom templates results in old behavior
                                                                                                                        • Introducing deprecated methods in generators or other shared code
                                                                                                                        patchNOnew features without breaking changes
                                                                                                                        • New generators
                                                                                                                        • Bug fixes in template or generators

                                                                                                                        Cadence

                                                                                                                        For patch release (e.g. 3.0.5 to 3.0.6), we plan to do it on a weekly basis.

                                                                                                                        For minor release (e.g. 3.1.6 to 3.2.0), we plan to do it on a monthly basis.

                                                                                                                        For major releases (e.g. 3.3.6 to 4.0.0), we plan to do it on a quarterly basis.

                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +

                                                                                                                        Release Summary

                                                                                                                        Versioning

                                                                                                                        We version artifacts in the common major.minor.patch strategy.

                                                                                                                        We decided versions should be incremented according to the following rules. The examples provided below are not exhaustive.

                                                                                                                        PartBreaking Changes?RuleExamples
                                                                                                                        majorYESbreaking changes without fallback
                                                                                                                        • New Features
                                                                                                                        • Large refactors
                                                                                                                        • Removal of deprecated code
                                                                                                                        • Changes to coding interfaces
                                                                                                                        • Large changes to template bound variables
                                                                                                                        minorALLOWEDbreaking changes with fallback
                                                                                                                        • Adding new generator behavior which doesn't affect custom templates (or does, with config option for old behavior)
                                                                                                                        • Changing generator templates in a way in which switching to custom templates results in old behavior
                                                                                                                        • Introducing deprecated methods in generators or other shared code
                                                                                                                        patchNOnew features without breaking changes
                                                                                                                        • New generators
                                                                                                                        • Bug fixes in template or generators

                                                                                                                        Cadence

                                                                                                                        For patch release (e.g. 3.0.5 to 3.0.6), we plan to do it on a weekly basis.

                                                                                                                        For minor release (e.g. 3.1.6 to 3.2.0), we plan to do it on a monthly basis.

                                                                                                                        For major releases (e.g. 3.3.6 to 4.0.0), we plan to do it on a quarterly basis.

                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/roadmap/index.html b/docs/roadmap/index.html index 271cbb4c5b0..bc88522ffaa 100644 --- a/docs/roadmap/index.html +++ b/docs/roadmap/index.html @@ -21,32 +21,32 @@ - +
                                                                                                                        -

                                                                                                                        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
                                                                                                                        • 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
                                                                                                                        • 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)
                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +

                                                                                                                        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
                                                                                                                        • 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
                                                                                                                        • 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)
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/spec-info/index.html b/docs/spec-info/index.html index 29af3237ea3..5048dbb2876 100644 --- a/docs/spec-info/index.html +++ b/docs/spec-info/index.html @@ -21,32 +21,32 @@ - +
                                                                                                                        -
                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/swagger-codegen-migration/index.html b/docs/swagger-codegen-migration/index.html index 3f549c44c1f..df07c142410 100644 --- a/docs/swagger-codegen-migration/index.html +++ b/docs/swagger-codegen-migration/index.html @@ -21,7 +21,7 @@ - + @@ -38,26 +38,26 @@ The syntax inside the file stays the same.

                                                                                                                        You don't need to rename t (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

                                                                                                                        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

                                                                                                                        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. You need to have a look at the specific value, depending of your target language, but often Swagger îs replaced by OpenAPITools and io.swagger is replaced by org.openapitools. -Concretely if you did not specify anything when you are generating java code, a file org/openapitools/api/PetApi.java might be generated instead of io/swagger/api/PetApi.java.

                                                                                                                        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

                                                                                                                        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

                                                                                                                        ‼️ Since 4.0.0-beta, the body parameter name in OAS v2 is automatically preserved in the vendor extension x-codegen-request-body-name

                                                                                                                        In OpenAPI spec v3, there's no body parameter, which is replaced by 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" parameter is named, please add the vendor extension x-codegen-request-body-name to the operation:

                                                                                                                        OpenAPI Spec v3:

                                                                                                                        paths:
                                                                                                                          /pet:
                                                                                                                            post:
                                                                                                                              tags:
                                                                                                                                - pet
                                                                                                                              summary: Add a new pet to the store
                                                                                                                              description: ''
                                                                                                                              operationId: addPet
                                                                                                                              x-codegen-request-body-name: new_body_name
                                                                                                                              responses:
                                                                                                                                '405':
                                                                                                                                  description: Invalid input
                                                                                                                              security:
                                                                                                                                - petstore_auth:
                                                                                                                                    - 'write:pets'
                                                                                                                                    - 'read:pets'
                                                                                                                              requestBody:
                                                                                                                                $ref: '#/components/requestBodies/Pet'

                                                                                                                        OpenAPI Spec v2:

                                                                                                                        paths:
                                                                                                                          /pet:
                                                                                                                            post:
                                                                                                                              tags:
                                                                                                                                - pet
                                                                                                                              summary: Add a new pet to the store
                                                                                                                              description: ''
                                                                                                                              operationId: addPet
                                                                                                                              x-codegen-request-body-name: new_body_name
                                                                                                                              consumes:
                                                                                                                                - application/json
                                                                                                                                - application/xml
                                                                                                                              produces:
                                                                                                                                - application/xml
                                                                                                                                - application/json
                                                                                                                              parameters:
                                                                                                                                - in: body
                                                                                                                                  name: body
                                                                                                                                  description: Pet object that needs to be added to the store
                                                                                                                                  required: true
                                                                                                                                  schema:
                                                                                                                                    $ref: '#/definitions/Pet'
                                                                                                                              responses:
                                                                                                                                '405':
                                                                                                                                  description: Invalid input
                                                                                                                              security:
                                                                                                                                - petstore_auth:
                                                                                                                                    - 'write:pets'
                                                                                                                                    - '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.

                                                                                                                        Default basePath

                                                                                                                        The default basePath has been changed from https://localhost to http://localhost (http without s)

                                                                                                                        Nullable

                                                                                                                        OpenAPI spec v3 has better support for nullable. If you're still using OpenAPI/Swagger spec v2, please use x-nullable: true instead.

                                                                                                                        Edit this page
                                                                                                                        Last updated on by William Cheng
                                                                                                                        +Concretely if you did not specify anything when you are generating java code, a file org/openapitools/api/PetApi.java might be generated instead of io/swagger/api/PetApi.java.

                                                                                                                        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

                                                                                                                        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

                                                                                                                        ‼️ Since 4.0.0-beta, the body parameter name in OAS v2 is automatically preserved in the vendor extension x-codegen-request-body-name

                                                                                                                        In OpenAPI spec v3, there's no body parameter, which is replaced by 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" parameter is named, please add the vendor extension x-codegen-request-body-name to the operation:

                                                                                                                        OpenAPI Spec v3:

                                                                                                                        paths:
                                                                                                                          /pet:
                                                                                                                            post:
                                                                                                                              tags:
                                                                                                                                - pet
                                                                                                                              summary: Add a new pet to the store
                                                                                                                              description: ''
                                                                                                                              operationId: addPet
                                                                                                                              x-codegen-request-body-name: new_body_name
                                                                                                                              responses:
                                                                                                                                '405':
                                                                                                                                  description: Invalid input
                                                                                                                              security:
                                                                                                                                - petstore_auth:
                                                                                                                                    - 'write:pets'
                                                                                                                                    - 'read:pets'
                                                                                                                              requestBody:
                                                                                                                                $ref: '#/components/requestBodies/Pet'

                                                                                                                        OpenAPI Spec v2:

                                                                                                                        paths:
                                                                                                                          /pet:
                                                                                                                            post:
                                                                                                                              tags:
                                                                                                                                - pet
                                                                                                                              summary: Add a new pet to the store
                                                                                                                              description: ''
                                                                                                                              operationId: addPet
                                                                                                                              x-codegen-request-body-name: new_body_name
                                                                                                                              consumes:
                                                                                                                                - application/json
                                                                                                                                - application/xml
                                                                                                                              produces:
                                                                                                                                - application/xml
                                                                                                                                - application/json
                                                                                                                              parameters:
                                                                                                                                - in: body
                                                                                                                                  name: body
                                                                                                                                  description: Pet object that needs to be added to the store
                                                                                                                                  required: true
                                                                                                                                  schema:
                                                                                                                                    $ref: '#/definitions/Pet'
                                                                                                                              responses:
                                                                                                                                '405':
                                                                                                                                  description: Invalid input
                                                                                                                              security:
                                                                                                                                - petstore_auth:
                                                                                                                                    - 'write:pets'
                                                                                                                                    - '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.

                                                                                                                        Default basePath

                                                                                                                        The default basePath has been changed from https://localhost to http://localhost (http without s)

                                                                                                                        Nullable

                                                                                                                        OpenAPI spec v3 has better support for nullable. If you're still using OpenAPI/Swagger spec v2, please use x-nullable: true instead.

                                                                                                                        Edit this page
                                                                                                                        Last updated on by Keenan Pepper
                                                                                                                        - + - + - + - + diff --git a/docs/templating/index.html b/docs/templating/index.html index 22ba8966373..24707c12f47 100644 --- a/docs/templating/index.html +++ b/docs/templating/index.html @@ -21,7 +21,7 @@ - + @@ -32,20 +32,20 @@ You'll see them referred to as "Vendor Extensions" in most places This is used to define names of the enum items.

                                                                                                                        x-enum-descriptions can be used to provide an individual description for each value. This is used for comments in the code (like javadoc if the target language is java).

                                                                                                                        x-enum-descriptions and x-enum-varnames are each expected to be list of items containing the same number of items as enum. The order of the items in the list matters: their position is used to group them together.

                                                                                                                        Example:

                                                                                                                        WeatherType:
                                                                                                                          type: integer
                                                                                                                          format: int32
                                                                                                                          enum:
                                                                                                                            - 42
                                                                                                                            - 18
                                                                                                                            - 56
                                                                                                                          x-enum-descriptions:
                                                                                                                            - 'Blue sky'
                                                                                                                            - 'Slightly overcast'
                                                                                                                            - 'Take an umbrella with you'
                                                                                                                          x-enum-varnames:
                                                                                                                            - Sunny
                                                                                                                            - Cloudy
                                                                                                                            - Rainy

                                                                                                                        In the example for the integer value 42, the description will be Blue sky and the name of the enum item will be Sunny (some generators changes it to SUNNY to respect some coding convention).

                                                                                                                        ObjC

                                                                                                                        x-objc-operationId

                                                                                                                        To customize the method name, you can provide a different name in x-objc-operationId, e.g.

                                                                                                                        summary: Add a new pet to the store
                                                                                                                        description: ''
                                                                                                                        operationId: addPet
                                                                                                                        x-objc-operationId: CreateNewPet

                                                                                                                        Java (Feign)

                                                                                                                        x-accepts

                                                                                                                        A single Accepts value as the Feign API client needs a single value for Accepts header, e.g.

                                                                                                                        consumes:
                                                                                                                          - application/json
                                                                                                                          - application/xml
                                                                                                                        x-accepts: application/json

                                                                                                                        x-content-type

                                                                                                                        A single "Content-Type" value as the Feign API client needs a single value for Content-Type header, e.g.

                                                                                                                        produces:
                                                                                                                          - application/xml
                                                                                                                          - application/json
                                                                                                                        x-content-type: application/json

                                                                                                                        Rust-server

                                                                                                                        x-responseId

                                                                                                                        Each response may specify a unique x-responseId. rust-server will use this to name the corresponding enum variant in the code. e.g.

                                                                                                                        paths:
                                                                                                                          /ping:
                                                                                                                            get:
                                                                                                                              responses:
                                                                                                                                200:
                                                                                                                                  description: OK
                                                                                                                                  x-responseId: Pong

                                                                                                                        MySQL Schema

                                                                                                                        x-mysqlSchema

                                                                                                                        MySQL schema generator creates vendor extensions based on openapi dataType and dataFormat. When user defined extensions with same key already exists codegen accepts those as is. It means it won't validate properties or correct it for you. Every model in definitions can contain table related and column related extensions like in example below:

                                                                                                                        definitions:
                                                                                                                          Order:
                                                                                                                            description: This should be most common InnoDB table
                                                                                                                            type: object
                                                                                                                            properties:
                                                                                                                              id:
                                                                                                                                description: >-
                                                                                                                                  This column should be unsigned BIGINT with AUTO_INCREMENT
                                                                                                                                type: integer
                                                                                                                                format: int64
                                                                                                                                x-mysqlSchema:
                                                                                                                                  columnDefinition:
                                                                                                                                    colName: id
                                                                                                                                    colDataType: DECIMAL
                                                                                                                                    colDataTypeArguments:
                                                                                                                                      - argumentValue: 16
                                                                                                                                        isString: false
                                                                                                                                        hasMore: true
                                                                                                                                      - argumentValue: 4
                                                                                                                                        isString: false
                                                                                                                                        hasMore: false
                                                                                                                                    colUnsigned: true
                                                                                                                                    colNotNull: true
                                                                                                                                    colDefault:
                                                                                                                                      defaultValue: AUTO_INCREMENT
                                                                                                                                      isString: false
                                                                                                                                      isNumeric: false
                                                                                                                                      isKeyword: true
                                                                                                                                    colComment: >-
                                                                                                                                      Column comment. This column should be unsigned BIGINT with AUTO_INCREMENT
                                                                                                                            x-mysqlSchema:
                                                                                                                              tableDefinition:
                                                                                                                                tblName: orders
                                                                                                                                tblStorageEngine: InnoDB
                                                                                                                                tblComment: >-
                                                                                                                                  Table comment. This should be most common InnoDB table

                                                                                                                        There are properties that are not implemented by now(tblStorageEngine), but you can see how generator can be enhanced in future.

                                                                                                                        Mustache Tips

                                                                                                                        Here are a few tips we've found useful for new template authors. -For more details on Mustache see mustache.5. See also samskivert/jmustache for implementation-specific details.

                                                                                                                        First/Last

                                                                                                                        To access the first or last element in a list using Mustache:

                                                                                                                        {{#vars}}{{#-first}} this is the first element {{.}} {{/-first}}{{/vars}}
                                                                                                                        {{#vars}}{{#-last}} this is the last element {{.}} {{/-last}}{{/vars}}

                                                                                                                        This

                                                                                                                        Mustache evaluates template variables contextually. If the variable isn't found in the immediate object, mustache will search the parent. This is similar to JavaScript's prototype object (if you're familiar with the concept).

                                                                                                                        You can inspect this entire context by outputting {{this}}. For example:

                                                                                                                        {{#operations}}{{this}}{{/operations}}

                                                                                                                        Index

                                                                                                                        If you'd like a 1-based index in your array traversal, you can use {{-index}}:

                                                                                                                        {{#enums}}{{-index}} {{enum}}{{/enums}}
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        +For more details on Mustache see mustache.5. See also samskivert/jmustache for implementation-specific details.

                                                                                                                        First/Last

                                                                                                                        To access the first or last element in a list using Mustache:

                                                                                                                        {{#vars}}{{#-first}} this is the first element {{.}} {{/-first}}{{/vars}}
                                                                                                                        {{#vars}}{{#-last}} this is the last element {{.}} {{/-last}}{{/vars}}

                                                                                                                        This

                                                                                                                        Mustache evaluates template variables contextually. If the variable isn't found in the immediate object, mustache will search the parent. This is similar to JavaScript's prototype object (if you're familiar with the concept).

                                                                                                                        You can inspect this entire context by outputting {{this}}. For example:

                                                                                                                        {{#operations}}{{this}}{{/operations}}

                                                                                                                        Index

                                                                                                                        If you'd like a 1-based index in your array traversal, you can use {{-index}}:

                                                                                                                        {{#enums}}{{-index}} {{enum}}{{/enums}}
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Jim Schubert
                                                                                                                        - + - + - + diff --git a/docs/usage/index.html b/docs/usage/index.html index a6087e4189c..d00cbc19c02 100644 --- a/docs/usage/index.html +++ b/docs/usage/index.html @@ -21,7 +21,7 @@ - + @@ -30,20 +30,20 @@

                                                                                                                        Usage

                                                                                                                        Options for OpenAPI Generator are the same whether you're using the CLI, Maven/Gradle Plugins, or Online generation options. This page demonstrates navigating the options via CLI. Commands are presented here in a logical progression as a tutorial, but you're welcome to skip directly to the generate command.

                                                                                                                        help

                                                                                                                        The help option lists all commands available to the CLI.

                                                                                                                        openapi-generator help
                                                                                                                        usage: openapi-generator-cli <command> [<args>]
                                                                                                                        The most commonly used openapi-generator-cli commands are:
                                                                                                                            config-help   Config help for chosen lang
                                                                                                                            generate      Generate code with the specified generator.
                                                                                                                            help          Display help information
                                                                                                                            list          Lists the available generators
                                                                                                                            meta          MetaGenerator. Generator for creating a new template set and configuration for Codegen.  The output will be based on the language you specify, and includes default templates to include.
                                                                                                                            validate      Validate specification
                                                                                                                            version       Show version information
                                                                                                                        See 'openapi-generator-cli help <command>' for more information on a specific
                                                                                                                        command.

                                                                                                                        list

                                                                                                                        The list command outputs a formatted list of every available generator. Pass the -s/--short option if you would like a CSV output for easy parsing.

                                                                                                                        openapi-generator help list
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli list - Lists the available generators
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli list [(-i <include> | --include <include>)]
                                                                                                                                        [(-s | --short)]
                                                                                                                        OPTIONS
                                                                                                                                -i <include>, --include <include>
                                                                                                                                    comma-separated list of stability indexes to include (value:
                                                                                                                                    all,beta,stable,experimental,deprecated). Excludes deprecated by
                                                                                                                                    default.
                                                                                                                                -s, --short
                                                                                                                                    shortened output (suitable for scripting)

                                                                                                                        Example:

                                                                                                                        openapi-generator list -s | tr ',' '\n'

                                                                                                                        For the full list of generators, refer to the Generators List.

                                                                                                                        config-help

                                                                                                                        The config-help option provides details about 

                                                                                                                        openapi-generator help config-help
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli config-help - Config help for chosen lang
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli config-help
                                                                                                                                        [(-f <output format> | --format <output format>)]
                                                                                                                                        [(-g <generator name> | --generator-name <generator name>)]
                                                                                                                                        [--markdown-header] [--named-header]
                                                                                                                                        [(-o <output location> | --output <output location>)]
                                                                                                                        OPTIONS
                                                                                                                                -f <output format>, --format <output format>
                                                                                                                                    Write output files in the desired format. Options are 'text',
                                                                                                                                    'markdown' or 'yamlsample'. Default is 'text'.
                                                                                                                                -g <generator name>, --generator-name <generator name>
                                                                                                                                    generator to get config help for
                                                                                                                                --markdown-header
                                                                                                                                    When format=markdown, include this option to write out markdown
                                                                                                                                    headers (e.g. for docusaurus).
                                                                                                                                --named-header
                                                                                                                                    Header includes the generator name, for clarity in output
                                                                                                                                -o <output location>, --output <output location>
                                                                                                                                    Optionally write help to this location, otherwise default is
                                                                                                                                    standard output

                                                                                                                        The option of note is -g/--generator-name (other options are exposed for tooling).

                                                                                                                        You may pass any generator name (see list command) to -g, and options specific to that generator will be displayed. Some generators have many options, while others may have only a few.

                                                                                                                        Example:

                                                                                                                        openapi-generator config-help -g go

                                                                                                                        Outputs:

                                                                                                                        CONFIG OPTIONS
                                                                                                                            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 in GitHub 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)

                                                                                                                        To pass these go client generator-specific options to the generate command for a go client, use the --additional-properties option. See the generate command section for an example.

                                                                                                                        meta

                                                                                                                        The meta command creates a new Java class and template files, used for creating your own custom templates.

                                                                                                                        openapi-generator help meta
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli meta - MetaGenerator. Generator for creating a new
                                                                                                                                template set and configuration for Codegen. The output will be based on
                                                                                                                                the language you specify, and includes default templates to include.
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli meta [(-n <name> | --name <name>)]
                                                                                                                                        [(-o <output directory> | --output <output directory>)]
                                                                                                                                        [(-p <package> | --package <package>)] [(-t <type> | --type <type>)]
                                                                                                                        OPTIONS
                                                                                                                                -n <name>, --name <name>
                                                                                                                                    the human-readable name of the generator
                                                                                                                                -o <output directory>, --output <output directory>
                                                                                                                                    where to write the generated files (current dir by default)
                                                                                                                                -p <package>, --package <package>
                                                                                                                                    the package to put the main class into (defaults to
                                                                                                                                    org.openapitools.codegen)
                                                                                                                                -t <type>, --type <type>
                                                                                                                                    the type of generator that is created

                                                                                                                        For an in-depth example of using the meta command, see Customization.

                                                                                                                        validate

                                                                                                                        The validate command allows you to validate an input specification, optionally providing recommendations for error fixes or other improvements (if available).

                                                                                                                        openapi-generator help validate
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli validate - Validate specification
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli validate
                                                                                                                                        (-i <spec file> | --input-spec <spec file>) [--recommend]
                                                                                                                        OPTIONS
                                                                                                                                -i <spec file>, --input-spec <spec file>
                                                                                                                                    location of the OpenAPI spec, as URL or file (required)
                                                                                                                                --recommend

                                                                                                                        Valid Spec Example (using petstore-v3.0.yaml)

                                                                                                                        openapi-generator validate -i petstore-v3.0.yaml
                                                                                                                        Validating spec (petstore-v3.0.yaml)
                                                                                                                        No validation issues detected.

                                                                                                                        Invalid Spec Example (using petstore-v3.0-invalid.yaml):

                                                                                                                        openapi-generator validate -i petstore-v3.0-invalid.yaml
                                                                                                                        Validating spec (petstore-v3.0-invalid.yaml)
                                                                                                                        Errors:
                                                                                                                            -attribute info is missing
                                                                                                                        [error] Spec has 1 errors.

                                                                                                                        completion

                                                                                                                        Although not documented in the help output, the CLI offers a completion command, which can be used for auto-completion.

                                                                                                                        This command takes one or more parameters representing the args list you would otherwise pass to openapi-generator. For example:

                                                                                                                        openapi-generator completion config-help
                                                                                                                        -o
                                                                                                                        --output
                                                                                                                        --named-header
                                                                                                                        -g
                                                                                                                        --generator-name
                                                                                                                        -f
                                                                                                                        --format
                                                                                                                        --markdown-header

                                                                                                                        An example bash completion script can be found in the repo at scripts/openapi-generator-cli-completion.bash.

                                                                                                                        generate

                                                                                                                        The generate command is the workhorse of the generator toolset. As such, it has many more options and the previous commands. The abbreviated options are below, but you may expand the full descriptions.

                                                                                                                        openapi-generator help generate
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli generate - Generate code with the specified
                                                                                                                                generator.
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli generate
                                                                                                                                        [(-a <authorization> | --auth <authorization>)]
                                                                                                                                        [--api-package <api package>] [--artifact-id <artifact id>]
                                                                                                                                        [--artifact-version <artifact version>]
                                                                                                                                        [(-c <configuration file> | --config <configuration file>)]
                                                                                                                                        [-D <system properties>...]
                                                                                                                                        [(-e <templating engine> | --engine <templating engine>)]
                                                                                                                                        [--enable-post-process-file]
                                                                                                                                        [(-g <generator name> | --generator-name <generator name>)]
                                                                                                                                        [--generate-alias-as-model] [--git-repo-id <git repo id>]
                                                                                                                                        [--git-user-id <git user id>] [--group-id <group id>]
                                                                                                                                        [--http-user-agent <http user agent>]
                                                                                                                                        (-i <spec file> | --input-spec <spec file>)
                                                                                                                                        [--ignore-file-override <ignore file override location>]
                                                                                                                                        [--import-mappings <import mappings>...]
                                                                                                                                        [--instantiation-types <instantiation types>...]
                                                                                                                                        [--invoker-package <invoker package>]
                                                                                                                                        [--language-specific-primitives <language specific primitives>...]
                                                                                                                                        [--library <library>] [--log-to-stderr] [--minimal-update]
                                                                                                                                        [--model-name-prefix <model name prefix>]
                                                                                                                                        [--model-name-suffix <model name suffix>]
                                                                                                                                        [--model-package <model package>]
                                                                                                                                        [(-o <output directory> | --output <output directory>)] 
                                                                                                                                        [(-p <additional properties> | --additional-properties <additional properties>)...]
                                                                                                                                        [--package-name <package name>] [--release-note <release note>]
                                                                                                                                        [--remove-operation-id-prefix]
                                                                                                                                        [--reserved-words-mappings <reserved word mappings>...]
                                                                                                                                        [(-s | --skip-overwrite)] [--server-variables <server variables>...]
                                                                                                                                        [--skip-validate-spec] [--strict-spec <true/false strict behavior>]
                                                                                                                                        [(-t <template directory> | --template-dir <template directory>)]
                                                                                                                                        [--type-mappings <type mappings>...] [(-v | --verbose)]
                                                                                                                        generate OPTIONS
                                                                                                                        OPTIONS
                                                                                                                                -a <authorization>, --auth <authorization>
                                                                                                                                    adds authorization headers when fetching the OpenAPI definitions
                                                                                                                                    remotely. Pass in a URL-encoded string of name:header with a comma
                                                                                                                                    separating multiple values
                                                                                                                                --api-package <api package>
                                                                                                                                    package for generated api classes
                                                                                                                                --artifact-id <artifact id>
                                                                                                                                    artifactId in generated pom.xml. This also becomes part of the
                                                                                                                                    generated library's filename
                                                                                                                                --artifact-version <artifact version>
                                                                                                                                    artifact version in generated pom.xml. This also becomes part of the
                                                                                                                                    generated library's filename
                                                                                                                                -c <configuration file>, --config <configuration file>
                                                                                                                                    Path to configuration file configuration file. It can be json or
                                                                                                                                    yaml.If file is json, the content should have the format
                                                                                                                                    {"optionKey":"optionValue", "optionKey1":"optionValue1"...}.If file
                                                                                                                                    is yaml, the content should have the format optionKey:
                                                                                                                                    optionValueSupported options can be different for each language. Run
                                                                                                                                    config-help -g {generator name} command for language specific config
                                                                                                                                    options.
                                                                                                                                -D <system properties>
                                                                                                                                    sets specified system properties in the format of
                                                                                                                                    name=value,name=value (or multiple options, each with name=value)
                                                                                                                                -e <templating engine>, --engine <templating engine>
                                                                                                                                    templating engine: "mustache" (default) or "handlebars" (beta)
                                                                                                                                --enable-post-process-file
                                                                                                                                    enablePostProcessFile
                                                                                                                                -g <generator name>, --generator-name <generator name>
                                                                                                                                    generator to use (see list command for list)
                                                                                                                                --generate-alias-as-model
                                                                                                                                    Generate model implementation for aliases to map and array schemas.
                                                                                                                                    An 'alias' is an array, map, or list which is defined inline in a 
                                                                                                                                    OpenAPI document and becomes a model in the generated code.
                                                                                                                                    A 'map' schema is an object that can have undeclared properties,
                                                                                                                                    i.e. the 'additionalproperties' attribute is set on that object.
                                                                                                                                    An 'array' schema is a list of sub schemas in a OAS document.
                                                                                                                                --git-repo-id <git repo id>
                                                                                                                                    Git repo ID, e.g. openapi-generator.
                                                                                                                                --git-user-id <git user id>
                                                                                                                                    Git user ID, e.g. openapitools.
                                                                                                                                --group-id <group id>
                                                                                                                                    groupId in generated pom.xml
                                                                                                                                --http-user-agent <http user agent>
                                                                                                                                    HTTP user agent, e.g. codegen_csharp_api_client, default to
                                                                                                                                    'OpenAPI-Generator/{packageVersion}}/{language}'
                                                                                                                                -i <spec file>, --input-spec <spec file>
                                                                                                                                    location of the OpenAPI spec, as URL or file (required)
                                                                                                                                --ignore-file-override <ignore file override location>
                                                                                                                                    Specifies an override location for the .openapi-generator-ignore
                                                                                                                                    file. Most useful on initial generation.
                                                                                                                                --import-mappings <import mappings>
                                                                                                                                    specifies mappings between a given class and the import that should
                                                                                                                                    be used for that class in the format of type=import,type=import. You
                                                                                                                                    can also have multiple occurrences of this option.
                                                                                                                                --instantiation-types <instantiation types>
                                                                                                                                    sets instantiation type mappings in the format of
                                                                                                                                    type=instantiatedType,type=instantiatedType.For example (in Java):
                                                                                                                                    array=ArrayList,map=HashMap. In other words array types will get
                                                                                                                                    instantiated as ArrayList in generated code. You can also have
                                                                                                                                    multiple occurrences of this option.
                                                                                                                                --invoker-package <invoker package>
                                                                                                                                    root package for generated code
                                                                                                                                --language-specific-primitives <language specific primitives>
                                                                                                                                    specifies additional language specific primitive types in the format
                                                                                                                                    of type1,type2,type3,type3. For example:
                                                                                                                                    String,boolean,Boolean,Double. You can also have multiple
                                                                                                                                    occurrences of this option.
                                                                                                                                --library <library>
                                                                                                                                    library template (sub-template)
                                                                                                                                --log-to-stderr
                                                                                                                                    write all log messages (not just errors) to STDOUT. Useful for
                                                                                                                                    piping the JSON output of debug options (e.g. `-DdebugOperations`)
                                                                                                                                    to an external parser directly while testing a generator.
                                                                                                                                --minimal-update
                                                                                                                                    Only write output files that have changed.
                                                                                                                                --model-name-prefix <model name prefix>
                                                                                                                                    Prefix that will be prepended to all model names. Default is the
                                                                                                                                    empty string.
                                                                                                                                --model-name-suffix <model name suffix>
                                                                                                                                    Suffix that will be appended to all model names. Default is the
                                                                                                                                    empty string.
                                                                                                                                --model-package <model package>
                                                                                                                                    package for generated models
                                                                                                                                -o <output directory>, --output <output directory>
                                                                                                                                    where to write the generated files (current dir by default)
                                                                                                                                -p <additional properties>, --additional-properties <additional
                                                                                                                                properties>
                                                                                                                                    sets additional properties that can be referenced by the mustache
                                                                                                                                    templates in the format of name=value,name=value. You can also have
                                                                                                                                    multiple occurrences of this option.
                                                                                                                                --package-name <package name>
                                                                                                                                    package for generated classes (where supported)
                                                                                                                                --release-note <release note>
                                                                                                                                    Release note, default to 'Minor update'.
                                                                                                                                --remove-operation-id-prefix
                                                                                                                                    Remove prefix of operationId, e.g. config_getId => getId
                                                                                                                                --reserved-words-mappings <reserved word mappings>
                                                                                                                                    specifies how a reserved name should be escaped to. Otherwise, the
                                                                                                                                    default _<name> is used. For example id=identifier. You can also
                                                                                                                                    have multiple occurrences of this option.
                                                                                                                                -s, --skip-overwrite
                                                                                                                                    specifies if the existing files should be overwritten during the
                                                                                                                                    generation.
                                                                                                                                --server-variables <server variables>
                                                                                                                                    sets server variables for spec documents which support variable
                                                                                                                                    templating of servers.
                                                                                                                                --skip-validate-spec
                                                                                                                                    Skips the default behavior of validating an input specification.
                                                                                                                                --strict-spec <true/false strict behavior>
                                                                                                                                    'MUST' and 'SHALL' wording in OpenAPI spec is strictly adhered to.
                                                                                                                                    e.g. when false, no fixes will be applied to documents which pass
                                                                                                                                    validation but don't follow the spec.
                                                                                                                                -t <template directory>, --template-dir <template directory>
                                                                                                                                    folder containing the template files
                                                                                                                                --type-mappings <type mappings>
                                                                                                                                    sets mappings between OpenAPI spec types and generated code types in
                                                                                                                                    the format of OpenAPIType=generatedType,OpenAPIType=generatedType.
                                                                                                                                    For example: array=List,map=Map,string=String. You can also have
                                                                                                                                    multiple occurrences of this option.
                                                                                                                                -v, --verbose
                                                                                                                                    verbose mode

                                                                                                                        At a minimum, generate requires:

                                                                                                                        • -g to specify the generator
                                                                                                                        • -o to specify a meaningful output directory (defaults to the current directory!)
                                                                                                                        • -i to specify the input OpenAPI document

                                                                                                                        NOTE You may also pass -Dcolor as a system property to colorize terminal outputs.

                                                                                                                        Examples

                                                                                                                        The following examples use petstore.yaml.

                                                                                                                        Additional Properties

                                                                                                                        Generator-specific options should be passed as --additional-properties:

                                                                                                                        openapi-generator generate -g go --additional-properties=prependFormOrBodyParameters=true \
                                                                                                                            -o out -i petstore.yaml

                                                                                                                        To pass more than one generator property, these can be combined via comma:

                                                                                                                        --additional-properties=key1=value1,key2=value2

                                                                                                                        For the full list of generator-specified parameters, refer to generators docs.

                                                                                                                        Type Mappings and Import Mappings

                                                                                                                        Most generators allow for types bound to the OpenAPI Specification's types to be remapped to a user's desired types. Not all type mappings can be reassigned, as some generators define mappings which are tightly coupled to the built-in templates.

                                                                                                                        If you're not using your own templates with star/glob package imports, you will most likely need to combine --type-mappings and --import-mappings together.

                                                                                                                        • --type-mappings Defines the user's target type
                                                                                                                        • --import-mappings Informs the template of the type to be imported

                                                                                                                        Here's how one might change the kotlin-spring server generator's default of OffsetDateTime to LocalDateTime:

                                                                                                                        openapi-generator generate \
                                                                                                                            -i petstore.yaml \
                                                                                                                            -g kotlin-spring \
                                                                                                                            -o out \
                                                                                                                            --additional-properties=library=spring-boot,beanValidations=true,swaggerAnnotations=true,serviceImplementation=true \
                                                                                                                            --import-mappings=DateTime=java.time.LocalDateTime \
                                                                                                                            --type-mappings=DateTime=java.time.LocalDateTime

                                                                                                                        NOTE: mappings are applied to DateTime, as this is the representation of the primitive type. See DefaultCodegen.

                                                                                                                        Target External Models

                                                                                                                        Sometimes you don't want the codegen to make a model for you--you might want to just include one that already exists in your codebase. Say you already have a User object and want to reuse that, which has a different model package from the other generated files:

                                                                                                                        First, indicate that the class is already included by default. This will keep the codegen from trying to generate the class.

                                                                                                                        --language-specific-primitives=Pet

                                                                                                                        This command line option will tell the generator to consider Pet a "primitive" type.

                                                                                                                        Next, if the Pet class is a different package, add an --import-mapping to tell the generator to include that import wherever Pet is used:

                                                                                                                        --import-mappings=Pet=com.yourpackage.models.Pet

                                                                                                                        Now the codegen will know what to import from that specific package.

                                                                                                                        NOTE: import-mappings is assigned a key-value pair in this example, but multiple values can be comma-separate. For instance:

                                                                                                                        --import-mappings=Pet=com.yourpackage.models.Pet,User=com.yourpackage.models.User

                                                                                                                        Configuration File

                                                                                                                        Rather than passing generator options in a CSV of --additional-properties, you may also provide the settings via JSON file or YAML file.

                                                                                                                        For example, one of our typescript samples has the following configuration file:

                                                                                                                        {
                                                                                                                          "npmName": "@swagger/typescript-fetch-petstore",
                                                                                                                          "npmVersion": "1.0.0",
                                                                                                                          "npmRepository" : "https://skimdb.npmjs.com/registry",
                                                                                                                          "snapshot" : false,
                                                                                                                          "supportsES6": true
                                                                                                                        }

                                                                                                                        These settings can be passed via -c filename. Here, we've saved the above as config.json:

                                                                                                                        openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
                                                                                                                            -c config.json

                                                                                                                        Same configuration file can be passed into YAML format having following equivalent content:

                                                                                                                        npmName: "@swagger/typescript-fetch-petstore"
                                                                                                                        npmVersion: "1.0.0"
                                                                                                                        npmRepository: "https://skimdb.npmjs.com/registry"
                                                                                                                        snapshot: false
                                                                                                                        supportsES6: true

                                                                                                                        The settings are passed exactly the same as for config.json. The most important part is the file extension. Supported values are yml or yaml. The name of the file should be config.yml or config.yaml (in our example it will be config.yaml.

                                                                                                                        openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
                                                                                                                            -c config.yaml

                                                                                                                        batch

                                                                                                                        The batch command allows you to move all CLI arguments supported by the generate command into a YAML or JSON file.

                                                                                                                        NOTE: This command supports an additional !include property which may point to another "shared" file, the base path to which can be -modified by --includes-base-dir.

                                                                                                                        openapi-generator help batch
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli batch - Generate code in batch via external
                                                                                                                                configs.
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli batch [--fail-fast]
                                                                                                                                        [--includes-base-dir <includes>] [(-r <threads> | --threads <threads>)]
                                                                                                                                        [--root-dir <root>] [--timeout <timeout>] [(-v | --verbose)] [--]
                                                                                                                                        <configs>...
                                                                                                                        OPTIONS
                                                                                                                                --fail-fast
                                                                                                                                    fail fast on any errors
                                                                                                                                --includes-base-dir <includes>
                                                                                                                                    base directory used for includes
                                                                                                                                -r <threads>, --threads <threads>
                                                                                                                                    thread count
                                                                                                                                --root-dir <root>
                                                                                                                                    root directory used output/includes (includes can be overridden)
                                                                                                                                --timeout <timeout>
                                                                                                                                    execution timeout (minutes)
                                                                                                                                -v, --verbose
                                                                                                                                    verbose mode
                                                                                                                                --
                                                                                                                                    This option can be used to separate command-line options from the
                                                                                                                                    list of argument, (useful when arguments might be mistaken for
                                                                                                                                    command-line options
                                                                                                                                <configs>
                                                                                                                                    Generator configuration files.

                                                                                                                        Example:

                                                                                                                        # create "shared" config
                                                                                                                        mkdir shared && cat > shared/common.yaml <<EOF
                                                                                                                        inputSpec: https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml
                                                                                                                        additionalProperties:
                                                                                                                            x-ext-name: "Your Name"
                                                                                                                        EOF
                                                                                                                        # create "standard" configs
                                                                                                                        cat > kotlin.yaml <<EOF
                                                                                                                        '!include': 'shared/common.yaml'
                                                                                                                        outputDir: out/kotlin
                                                                                                                        generatorName: kotlin
                                                                                                                        artifactId: kotlin-petstore-string
                                                                                                                        additionalProperties:
                                                                                                                          dateLibrary: string
                                                                                                                          serializableModel: "true"
                                                                                                                        EOF
                                                                                                                        cat > csharp.yaml <<EOF
                                                                                                                        '!include': 'shared/common.yaml'
                                                                                                                        outputDir: out/csharp-netcore
                                                                                                                        generatorName: csharp-netcore
                                                                                                                        additionalProperties:
                                                                                                                          packageGuid: "{321C8C3F-0156-40C1-AE42-D59761FB9B6C}"
                                                                                                                          useCompareNetObjects: "true"
                                                                                                                        EOF
                                                                                                                        # Generate them
                                                                                                                        openapi-generator batch *.yaml
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Sebastien Rosset
                                                                                                                        +modified by --includes-base-dir.

                                                                                                                        openapi-generator help batch
                                                                                                                        NAME
                                                                                                                                openapi-generator-cli batch - Generate code in batch via external
                                                                                                                                configs.
                                                                                                                        SYNOPSIS
                                                                                                                                openapi-generator-cli batch [--fail-fast]
                                                                                                                                        [--includes-base-dir <includes>] [(-r <threads> | --threads <threads>)]
                                                                                                                                        [--root-dir <root>] [--timeout <timeout>] [(-v | --verbose)] [--]
                                                                                                                                        <configs>...
                                                                                                                        OPTIONS
                                                                                                                                --fail-fast
                                                                                                                                    fail fast on any errors
                                                                                                                                --includes-base-dir <includes>
                                                                                                                                    base directory used for includes
                                                                                                                                -r <threads>, --threads <threads>
                                                                                                                                    thread count
                                                                                                                                --root-dir <root>
                                                                                                                                    root directory used output/includes (includes can be overridden)
                                                                                                                                --timeout <timeout>
                                                                                                                                    execution timeout (minutes)
                                                                                                                                -v, --verbose
                                                                                                                                    verbose mode
                                                                                                                                --
                                                                                                                                    This option can be used to separate command-line options from the
                                                                                                                                    list of argument, (useful when arguments might be mistaken for
                                                                                                                                    command-line options
                                                                                                                                <configs>
                                                                                                                                    Generator configuration files.

                                                                                                                        Example:

                                                                                                                        # create "shared" config
                                                                                                                        mkdir shared && cat > shared/common.yaml <<EOF
                                                                                                                        inputSpec: https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/test/resources/2_0/petstore.yaml
                                                                                                                        additionalProperties:
                                                                                                                            x-ext-name: "Your Name"
                                                                                                                        EOF
                                                                                                                        # create "standard" configs
                                                                                                                        cat > kotlin.yaml <<EOF
                                                                                                                        '!include': 'shared/common.yaml'
                                                                                                                        outputDir: out/kotlin
                                                                                                                        generatorName: kotlin
                                                                                                                        artifactId: kotlin-petstore-string
                                                                                                                        additionalProperties:
                                                                                                                          dateLibrary: string
                                                                                                                          serializableModel: "true"
                                                                                                                        EOF
                                                                                                                        cat > csharp.yaml <<EOF
                                                                                                                        '!include': 'shared/common.yaml'
                                                                                                                        outputDir: out/csharp-netcore
                                                                                                                        generatorName: csharp-netcore
                                                                                                                        additionalProperties:
                                                                                                                          packageGuid: "{321C8C3F-0156-40C1-AE42-D59761FB9B6C}"
                                                                                                                          useCompareNetObjects: "true"
                                                                                                                        EOF
                                                                                                                        # Generate them
                                                                                                                        openapi-generator batch *.yaml
                                                                                                                        Edit this page
                                                                                                                        Last updated on by Sebastien Rosset
                                                                                                                        - + - + - + diff --git a/e360e27f.f40b8b31.js b/e360e27f.30da012c.js similarity index 98% rename from e360e27f.f40b8b31.js rename to e360e27f.30da012c.js index f3fdae90dc9..83049026714 100644 --- a/e360e27f.f40b8b31.js +++ b/e360e27f.30da012c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{272:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return l})),n.d(t,"metadata",(function(){return p})),n.d(t,"rightToc",(function(){return i})),n.d(t,"default",(function(){return s}));var a=n(1),r=n(9),o=(n(0),n(296)),l={id:"plugins",title:"Plugins"},p={id:"plugins",title:"Plugins",description:"## Maven",source:"@site/../docs/plugins.md",permalink:"/docs/plugins",editUrl:"https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/plugins.md",lastUpdatedBy:"William Cheng",lastUpdatedAt:1581087531,sidebar:"docs",previous:{title:"CLI Installation",permalink:"/docs/installation"},next:{title:"Online",permalink:"/docs/online"}},i=[{value:"Maven",id:"maven",children:[{value:"Example",id:"example",children:[]}]},{value:"Gradle",id:"gradle",children:[{value:"Example",id:"example-1",children:[]}]}],c={rightToc:i};function s(e){var t=e.components,n=Object(r.a)(e,["components"]);return Object(o.b)("wrapper",Object(a.a)({},c,n,{components:t,mdxType:"MDXLayout"}),Object(o.b)("h2",{id:"maven"},"Maven"),Object(o.b)("p",null,"A Maven plugin to support the OpenAPI generator project"),Object(o.b)("h3",{id:"example"},"Example"),Object(o.b)("p",null,"Add to your ",Object(o.b)("inlineCode",{parentName:"p"},"build->plugins")," section (default phase is ",Object(o.b)("inlineCode",{parentName:"p"},"generate-sources")," phase)"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator-maven-plugin\n 3.3.4\n \n \n \n generate\n \n \n ${project.basedir}/src/main/resources/api.yaml\n java\n \n src/gen/java/main\n \n \n \n \n\n")),Object(o.b)("p",null,"Followed by:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),"mvn clean compile\n")),Object(o.b)("p",null,"For full details of all options, see the ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin"}),"plugin README"),"."),Object(o.b)("h2",{id:"gradle"},"Gradle"),Object(o.b)("p",null,"This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you\u2019d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you\u2019re interested in the extension/task mapping concept from a high-level, you can check out ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"https://docs.gradle.org/current/userguide/custom_plugins.html#sec:mapping_extension_properties_to_task_properties"}),"Gradle\u2019s docs"),"."),Object(o.b)("p",null,"To include in your project, add the following to ",Object(o.b)("inlineCode",{parentName:"p"},"build.gradle"),":"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-groovy"}),'buildscript {\n repositories {\n mavenLocal()\n maven { url "https://repo1.maven.org/maven2" }\n }\n dependencies {\n classpath "org.openapitools:openapi-generator-gradle-plugin:3.3.4"\n }\n}\n\napply plugin: \'org.openapi.generator\'\n')),Object(o.b)("p",null,"This gives access to the following tasks:"),Object(o.b)("table",null,Object(o.b)("thead",{parentName:"table"},Object(o.b)("tr",{parentName:"thead"},Object(o.b)("th",Object(a.a)({parentName:"tr"},{align:null}),"Task"),Object(o.b)("th",Object(a.a)({parentName:"tr"},{align:null}),"Description"))),Object(o.b)("tbody",{parentName:"table"},Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiGenerate"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Generate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.")),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiGenerators"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Lists generators available via Open API Generators.")),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiMeta"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Generates a new generator to be consumed via Open API Generator.")),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiValidate"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Validates an Open API 2.0 or 3.x specification document.")))),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"The plugin implements the above tasks as project extensions of the same name. If you\u2019d like to declare these tasks as dependencies to other tasks (using ",Object(o.b)("inlineCode",{parentName:"p"},"dependsOn"),"), you\u2019ll need a task reference. e.g.:"),Object(o.b)("pre",{parentName:"blockquote"},Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-groovy"}),"compileJava.dependsOn tasks.openApiGenerate\n"))),Object(o.b)("p",null,"For full details of all options, see the ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-gradle-plugin"}),"plugin README"),"."),Object(o.b)("h3",{id:"example-1"},"Example"),Object(o.b)("p",null,"An example task for generating a kotlin client:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-groovy"}),'openApiGenerate {\n generatorName = "kotlin"\n inputSpec = "$rootDir/specs/petstore-v3.0.yaml".toString()\n outputDir = "$buildDir/generated".toString()\n apiPackage = "org.openapi.example.api"\n invokerPackage = "org.openapi.example.invoker"\n modelPackage = "org.openapi.example.model"\n modelFilesConstrainedTo = [\n "Error"\n ]\n configOptions = [\n dateLibrary: "java8"\n ]\n}\n')))}s.isMDXComponent=!0},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return b})),n.d(t,"b",(function(){return m}));var a=n(0),r=n.n(a);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=r.a.createContext({}),s=function(e){var t=r.a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):p({},t,{},e)),n},b=function(e){var t=s(e.components);return r.a.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},d=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),b=s(n),d=a,m=b["".concat(l,".").concat(d)]||b[d]||u[d]||o;return n?r.a.createElement(m,p({ref:t},c,{components:n})):r.a.createElement(m,p({ref:t},c))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=d;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var c=2;cplugins")," section (default phase is ",Object(o.b)("inlineCode",{parentName:"p"},"generate-sources")," phase)"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-xml"}),"\n org.openapitools\n openapi-generator-maven-plugin\n 3.3.4\n \n \n \n generate\n \n \n ${project.basedir}/src/main/resources/api.yaml\n java\n \n src/gen/java/main\n \n \n \n \n\n")),Object(o.b)("p",null,"Followed by:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-bash"}),"mvn clean compile\n")),Object(o.b)("p",null,"For full details of all options, see the ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-maven-plugin"}),"plugin README"),"."),Object(o.b)("h2",{id:"gradle"},"Gradle"),Object(o.b)("p",null,"This gradle plugin offers a declarative DSL via extensions (these are Gradle project extensions). These map almost fully 1:1 with the options you\u2019d pass to the CLI or Maven plugin. The plugin maps the extensions to a task of the same name to provide a clean API. If you\u2019re interested in the extension/task mapping concept from a high-level, you can check out ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"https://docs.gradle.org/current/userguide/custom_plugins.html#sec:mapping_extension_properties_to_task_properties"}),"Gradle\u2019s docs"),"."),Object(o.b)("p",null,"To include in your project, add the following to ",Object(o.b)("inlineCode",{parentName:"p"},"build.gradle"),":"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-groovy"}),'buildscript {\n repositories {\n mavenLocal()\n maven { url "https://repo1.maven.org/maven2" }\n }\n dependencies {\n classpath "org.openapitools:openapi-generator-gradle-plugin:3.3.4"\n }\n}\n\napply plugin: \'org.openapi.generator\'\n')),Object(o.b)("p",null,"This gives access to the following tasks:"),Object(o.b)("table",null,Object(o.b)("thead",{parentName:"table"},Object(o.b)("tr",{parentName:"thead"},Object(o.b)("th",Object(a.a)({parentName:"tr"},{align:null}),"Task"),Object(o.b)("th",Object(a.a)({parentName:"tr"},{align:null}),"Description"))),Object(o.b)("tbody",{parentName:"table"},Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiGenerate"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Generate code via Open API Tools Generator for Open API 2.0 or 3.x specification documents.")),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiGenerators"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Lists generators available via Open API Generators.")),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiMeta"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Generates a new generator to be consumed via Open API Generator.")),Object(o.b)("tr",{parentName:"tbody"},Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"openApiValidate"),Object(o.b)("td",Object(a.a)({parentName:"tr"},{align:null}),"Validates an Open API 2.0 or 3.x specification document.")))),Object(o.b)("blockquote",null,Object(o.b)("p",{parentName:"blockquote"},"The plugin implements the above tasks as project extensions of the same name. If you\u2019d like to declare these tasks as dependencies to other tasks (using ",Object(o.b)("inlineCode",{parentName:"p"},"dependsOn"),"), you\u2019ll need a task reference. e.g.:"),Object(o.b)("pre",{parentName:"blockquote"},Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-groovy"}),"compileJava.dependsOn tasks.openApiGenerate\n"))),Object(o.b)("p",null,"For full details of all options, see the ",Object(o.b)("a",Object(a.a)({parentName:"p"},{href:"https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator-gradle-plugin"}),"plugin README"),"."),Object(o.b)("h3",{id:"example-1"},"Example"),Object(o.b)("p",null,"An example task for generating a kotlin client:"),Object(o.b)("pre",null,Object(o.b)("code",Object(a.a)({parentName:"pre"},{className:"language-groovy"}),'openApiGenerate {\n generatorName = "kotlin"\n inputSpec = "$rootDir/specs/petstore-v3.0.yaml".toString()\n outputDir = "$buildDir/generated".toString()\n apiPackage = "org.openapi.example.api"\n invokerPackage = "org.openapi.example.invoker"\n modelPackage = "org.openapi.example.model"\n modelFilesConstrainedTo = [\n "Error"\n ]\n configOptions = [\n dateLibrary: "java8"\n ]\n}\n')))}s.isMDXComponent=!0},296:function(e,t,n){"use strict";n.d(t,"a",(function(){return b})),n.d(t,"b",(function(){return m}));var a=n(0),r=n.n(a);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function p(e){for(var t=1;t=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var c=r.a.createContext({}),s=function(e){var t=r.a.useContext(c),n=t;return e&&(n="function"==typeof e?e(t):p({},t,{},e)),n},b=function(e){var t=s(e.components);return r.a.createElement(c.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},d=Object(a.forwardRef)((function(e,t){var n=e.components,a=e.mdxType,o=e.originalType,l=e.parentName,c=i(e,["components","mdxType","originalType","parentName"]),b=s(n),d=a,m=b["".concat(l,".").concat(d)]||b[d]||u[d]||o;return n?r.a.createElement(m,p({ref:t},c,{components:n})):r.a.createElement(m,p({ref:t},c))}));function m(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var o=n.length,l=new Array(o);l[0]=d;var p={};for(var i in t)hasOwnProperty.call(t,i)&&(p[i]=t[i]);p.originalType=e,p.mdxType="string"==typeof e?e:a,l[1]=p;for(var c=2;c"),", e.g. open a shell in ",Object(o.b)("inlineCode",{parentName:"li"},"samples/client/petstore/python"),", run ",Object(o.b)("inlineCode",{parentName:"li"},"mvn integration-test -rf :PythonPetstoreClientTests"),". The artifactId of the project can be found in the pom.xml file. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)"),Object(o.b)("li",{parentName:"ul"},"Finally, git commit the updated samples files: ",Object(o.b)("inlineCode",{parentName:"li"},"git commit -a"),"\n(",Object(o.b)("inlineCode",{parentName:"li"},"git add -A")," if added files with new test cases)"),Object(o.b)("li",{parentName:"ul"},"For new test cases, please add to the ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml"}),"Fake Petstore spec"))),Object(o.b)("p",null,"To start the CI tests, you can run ",Object(o.b)("inlineCode",{parentName:"p"},"mvn verify -Psamples")," (assuming you've all the required tools installed to run tests for different languages) or you can leverage ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"http://travis-ci.org"}),"http://travis-ci.org")," to run the CI tests by adding your own openapi-generator repository."),Object(o.b)("h3",{id:"tips"},"Tips"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Smaller changes are easier to review"),Object(o.b)("li",{parentName:"ul"},"[Optional]"," For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix"),Object(o.b)("li",{parentName:"ul"},"Add test case(s) to cover the change"),Object(o.b)("li",{parentName:"ul"},"Document the fix in the code to make the code more readable"),Object(o.b)("li",{parentName:"ul"},"Make sure test cases passed after the change (one way is to leverage ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://travis-ci.org/"}),"https://travis-ci.org/")," to run the CI tests)"),Object(o.b)("li",{parentName:"ul"},"File a PR with meaningful title, description and commit messages."),Object(o.b)("li",{parentName:"ul"},"Recommended git settings",Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},Object(o.b)("inlineCode",{parentName:"li"},"git config core.autocrlf input")," to tell Git convert CRLF to LF on commit but not the other way around "))),Object(o.b)("li",{parentName:"ul"},'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. ',Object(o.b)("inlineCode",{parentName:"li"},"fix #1542"),". (Ref: ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://help.github.com/articles/closing-issues-using-keywords/"}),"closing issues using keywords"),")")))}c.isMDXComponent=!0},296:function(e,t,a){"use strict";a.d(t,"a",(function(){return p})),a.d(t,"b",(function(){return h}));var n=a(0),i=a.n(n);function o(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var b=i.a.createContext({}),c=function(e){var t=i.a.useContext(b),a=t;return e&&(a="function"==typeof e?e(t):s({},t,{},e)),a},p=function(e){var t=c(e.components);return i.a.createElement(b.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.a.createElement(i.a.Fragment,{},t)}},m=Object(n.forwardRef)((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,r=e.parentName,b=l(e,["components","mdxType","originalType","parentName"]),p=c(a),m=n,h=p["".concat(r,".").concat(m)]||p[m]||u[m]||o;return a?i.a.createElement(h,s({ref:t},b,{components:a})):i.a.createElement(h,s({ref:t},b))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,r=new Array(o);r[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:n,r[1]=s;for(var b=2;b"),", e.g. open a shell in ",Object(o.b)("inlineCode",{parentName:"li"},"samples/client/petstore/python"),", run ",Object(o.b)("inlineCode",{parentName:"li"},"mvn integration-test -rf :PythonPetstoreClientTests"),". The artifactId of the project can be found in the pom.xml file. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)"),Object(o.b)("li",{parentName:"ul"},"Finally, git commit the updated samples files: ",Object(o.b)("inlineCode",{parentName:"li"},"git commit -a"),"\n(",Object(o.b)("inlineCode",{parentName:"li"},"git add -A")," if added files with new test cases)"),Object(o.b)("li",{parentName:"ul"},"For new test cases, please add to the ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml"}),"Fake Petstore spec"))),Object(o.b)("p",null,"To start the CI tests, you can run ",Object(o.b)("inlineCode",{parentName:"p"},"mvn verify -Psamples")," (assuming you've all the required tools installed to run tests for different languages) or you can leverage ",Object(o.b)("a",Object(n.a)({parentName:"p"},{href:"http://travis-ci.org"}),"http://travis-ci.org")," to run the CI tests by adding your own openapi-generator repository."),Object(o.b)("h3",{id:"tips"},"Tips"),Object(o.b)("ul",null,Object(o.b)("li",{parentName:"ul"},"Smaller changes are easier to review"),Object(o.b)("li",{parentName:"ul"},"[Optional]"," For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix"),Object(o.b)("li",{parentName:"ul"},"Add test case(s) to cover the change"),Object(o.b)("li",{parentName:"ul"},"Document the fix in the code to make the code more readable"),Object(o.b)("li",{parentName:"ul"},"Make sure test cases passed after the change (one way is to leverage ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://travis-ci.org/"}),"https://travis-ci.org/")," to run the CI tests)"),Object(o.b)("li",{parentName:"ul"},"File a PR with meaningful title, description and commit messages."),Object(o.b)("li",{parentName:"ul"},"Recommended git settings",Object(o.b)("ul",{parentName:"li"},Object(o.b)("li",{parentName:"ul"},Object(o.b)("inlineCode",{parentName:"li"},"git config core.autocrlf input")," to tell Git convert CRLF to LF on commit but not the other way around "))),Object(o.b)("li",{parentName:"ul"},'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. ',Object(o.b)("inlineCode",{parentName:"li"},"fix #1542"),". (Ref: ",Object(o.b)("a",Object(n.a)({parentName:"li"},{href:"https://help.github.com/articles/closing-issues-using-keywords/"}),"closing issues using keywords"),")")))}c.isMDXComponent=!0},296:function(e,t,a){"use strict";a.d(t,"a",(function(){return p})),a.d(t,"b",(function(){return h}));var n=a(0),i=a.n(n);function o(e,t,a){return t in e?Object.defineProperty(e,t,{value:a,enumerable:!0,configurable:!0,writable:!0}):e[t]=a,e}function r(e,t){var a=Object.keys(e);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(e);t&&(n=n.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),a.push.apply(a,n)}return a}function s(e){for(var t=1;t=0||(i[a]=e[a]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(e,a)&&(i[a]=e[a])}return i}var b=i.a.createContext({}),c=function(e){var t=i.a.useContext(b),a=t;return e&&(a="function"==typeof e?e(t):s({},t,{},e)),a},p=function(e){var t=c(e.components);return i.a.createElement(b.Provider,{value:t},e.children)},u={inlineCode:"code",wrapper:function(e){var t=e.children;return i.a.createElement(i.a.Fragment,{},t)}},m=Object(n.forwardRef)((function(e,t){var a=e.components,n=e.mdxType,o=e.originalType,r=e.parentName,b=l(e,["components","mdxType","originalType","parentName"]),p=c(a),m=n,h=p["".concat(r,".").concat(m)]||p[m]||u[m]||o;return a?i.a.createElement(h,s({ref:t},b,{components:a})):i.a.createElement(h,s({ref:t},b))}));function h(e,t){var a=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var o=a.length,r=new Array(o);r[0]=m;var s={};for(var l in t)hasOwnProperty.call(t,l)&&(s[l]=t[l]);s.originalType=e,s.mdxType="string"==typeof e?e:n,r[1]=s;for(var b=2;b=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=i.a.createContext({}),p=function(e){var t=i.a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},u=function(e){var t=p(e.components);return i.a.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return i.a.createElement(i.a.Fragment,{},t)}},b=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,a=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=p(n),b=r,m=u["".concat(a,".").concat(b)]||u[b]||d[b]||o;return n?i.a.createElement(m,c({ref:t},s,{components:n})):i.a.createElement(m,c({ref:t},s))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,a=new Array(o);a[0]=b;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:r,a[1]=c;for(var s=2;s=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=i.a.createContext({}),p=function(e){var t=i.a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):c({},t,{},e)),n},u=function(e){var t=p(e.components);return i.a.createElement(s.Provider,{value:t},e.children)},d={inlineCode:"code",wrapper:function(e){var t=e.children;return i.a.createElement(i.a.Fragment,{},t)}},b=Object(r.forwardRef)((function(e,t){var n=e.components,r=e.mdxType,o=e.originalType,a=e.parentName,s=l(e,["components","mdxType","originalType","parentName"]),u=p(n),b=r,m=u["".concat(a,".").concat(b)]||u[b]||d[b]||o;return n?i.a.createElement(m,c({ref:t},s,{components:n})):i.a.createElement(m,c({ref:t},s))}));function m(e,t){var n=arguments,r=t&&t.mdxType;if("string"==typeof e||r){var o=n.length,a=new Array(o);a[0]=b;var c={};for(var l in t)hasOwnProperty.call(t,l)&&(c[l]=t[l]);c.originalType=e,c.mdxType="string"==typeof e?e:r,a[1]=c;for(var s=2;s - + @@ -32,15 +32,15 @@ - + - + - + diff --git a/main.429a9e72.js b/main.25b2c56a.js similarity index 99% rename from main.429a9e72.js rename to main.25b2c56a.js index 7d9d56d3411..19739e3c870 100644 --- a/main.429a9e72.js +++ b/main.25b2c56a.js @@ -1,2 +1,2 @@ -/*! For license information please see main.429a9e72.js.LICENSE.txt */ -(window.webpackJsonp=window.webpackJsonp||[]).push([[165],[function(e,t,n){"use strict";e.exports=n(76)},function(e,t,n){"use strict";function r(){return(r=Object.assign||function(e){for(var t=1;t=0;d--){var p=i[d];"."===p?a(i,d):".."===p?(a(i,d),f++):f&&(a(i,d),f--)}if(!u)for(;f--;f)i.unshift("..");!u||""===i[0]||i[0]&&o(i[0])||i.unshift("");var m=i.join("/");return n&&"/"!==m.substr(-1)&&(m+="/"),m};function c(e){return e.valueOf?e.valueOf():Object.prototype.valueOf.call(e)}var l=function e(t,n){if(t===n)return!0;if(null==t||null==n)return!1;if(Array.isArray(t))return Array.isArray(n)&&t.length===n.length&&t.every((function(t,r){return e(t,n[r])}));if("object"==typeof t||"object"==typeof n){var r=c(t),o=c(n);return r!==t||o!==n?e(r,o):Object.keys(Object.assign({},t,n)).every((function(r){return e(t[r],n[r])}))}return!1},u=n(4);function s(e){return"/"===e.charAt(0)?e:"/"+e}function f(e){return"/"===e.charAt(0)?e.substr(1):e}function d(e,t){return function(e,t){return 0===e.toLowerCase().indexOf(t.toLowerCase())&&-1!=="/?#".indexOf(e.charAt(t.length))}(e,t)?e.substr(t.length):e}function p(e){return"/"===e.charAt(e.length-1)?e.slice(0,-1):e}function m(e){var t=e.pathname,n=e.search,r=e.hash,o=t||"/";return n&&"?"!==n&&(o+="?"===n.charAt(0)?n:"?"+n),r&&"#"!==r&&(o+="#"===r.charAt(0)?r:"#"+r),o}function h(e,t,n,o){var a;"string"==typeof e?(a=function(e){var t=e||"/",n="",r="",o=t.indexOf("#");-1!==o&&(r=t.substr(o),t=t.substr(0,o));var a=t.indexOf("?");return-1!==a&&(n=t.substr(a),t=t.substr(0,a)),{pathname:t,search:"?"===n?"":n,hash:"#"===r?"":r}}(e)).state=t:(void 0===(a=Object(r.a)({},e)).pathname&&(a.pathname=""),a.search?"?"!==a.search.charAt(0)&&(a.search="?"+a.search):a.search="",a.hash?"#"!==a.hash.charAt(0)&&(a.hash="#"+a.hash):a.hash="",void 0!==t&&void 0===a.state&&(a.state=t));try{a.pathname=decodeURI(a.pathname)}catch(c){throw c instanceof URIError?new URIError('Pathname "'+a.pathname+'" could not be decoded. This is likely caused by an invalid percent-encoding.'):c}return n&&(a.key=n),o?a.pathname?"/"!==a.pathname.charAt(0)&&(a.pathname=i(a.pathname,o.pathname)):a.pathname=o.pathname:a.pathname||(a.pathname="/"),a}function g(e,t){return e.pathname===t.pathname&&e.search===t.search&&e.hash===t.hash&&e.key===t.key&&l(e.state,t.state)}function v(){var e=null;var t=[];return{setPrompt:function(t){return e=t,function(){e===t&&(e=null)}},confirmTransitionTo:function(t,n,r,o){if(null!=e){var a="function"==typeof e?e(t,n):e;"string"==typeof a?"function"==typeof r?r(a,o):o(!0):o(!1!==a)}else o(!0)},appendListener:function(e){var n=!0;function r(){n&&e.apply(void 0,arguments)}return t.push(r),function(){n=!1,t=t.filter((function(e){return e!==r}))}},notifyListeners:function(){for(var e=arguments.length,n=new Array(e),r=0;rt?n.splice(t,n.length-t,r):n.push(r),f({action:"PUSH",location:r,index:t,entries:n})}}))},replace:function(e,t){var r=h(e,t,d(),w.location);s.confirmTransitionTo(r,"REPLACE",n,(function(e){e&&(w.entries[w.index]=r,f({action:"REPLACE",location:r}))}))},go:y,goBack:function(){y(-1)},goForward:function(){y(1)},canGo:function(e){var t=w.index+e;return t>=0&&t=0||(o[n]=e[n]);return o}n.d(t,"a",(function(){return r}))},function(e,t,n){var r=n(24),o=n(52);e.exports=n(11)?function(e,t,n){return r.f(e,t,o(1,n))}:function(e,t,n){return e[t]=n,e}},function(e,t,n){e.exports=!n(19)((function(){return 7!=Object.defineProperty({},"a",{get:function(){return 7}}).a}))},function(e,t){e.exports=function(e){return"object"==typeof e?null!==e:"function"==typeof e}},function(e,t){var n=e.exports={version:"2.6.10"};"number"==typeof __e&&(__e=n)},function(e,t,n){var r=n(5),o=n(10),a=n(27),i=n(40)("src"),c=n(84),l=(""+c).split("toString");n(13).inspectSource=function(e){return c.call(e)},(e.exports=function(e,t,n,c){var u="function"==typeof n;u&&(a(n,"name")||o(n,"name",t)),e[t]!==n&&(u&&(a(n,i)||o(n,i,e[t]?""+e[t]:l.join(String(t)))),e===r?e[t]=n:c?e[t]?e[t]=n:o(e,t,n):(delete e[t],o(e,t,n)))})(Function.prototype,"toString",(function(){return"function"==typeof this&&this[i]||c.call(this)}))},function(e,t,n){"use strict";n.d(t,"a",(function(){return c})),n.d(t,"b",(function(){return l}));var r=n(3),o=n(1),a=n(0),i=n.n(a);function c(e,t,n){return void 0===n&&(n=[]),e.some((function(e){var o=e.path?Object(r.f)(t,e):n.length?n[n.length-1].match:r.c.computeRootMatch(t);return o&&(n.push({route:e,match:o}),e.routes&&c(e.routes,t,n)),o})),n}function l(e,t,n){return void 0===t&&(t={}),void 0===n&&(n={}),e?i.a.createElement(r.d,n,e.map((function(e,n){return i.a.createElement(r.b,{key:e.key||n,path:e.path,exact:e.exact,strict:e.strict,render:function(n){return e.render?e.render(Object(o.a)({},n,{},t,{route:e})):i.a.createElement(e.component,Object(o.a)({},n,t,{route:e}))}})}))):null}},function(e,t,n){var r=n(5),o=n(13),a=n(10),i=n(14),c=n(28),l=function(e,t,n){var u,s,f,d,p=e&l.F,m=e&l.G,h=e&l.S,g=e&l.P,v=e&l.B,b=m?r:h?r[t]||(r[t]={}):(r[t]||{}).prototype,y=m?o:o[t]||(o[t]={}),w=y.prototype||(y.prototype={});for(u in m&&(n=t),n)f=((s=!p&&b&&void 0!==b[u])?b:n)[u],d=v&&s?c(f,r):g&&"function"==typeof f?c(Function.call,f):f,b&&i(b,u,f,e&l.U),y[u]!=f&&a(y,u,d),g&&w[u]!=f&&(w[u]=f)};r.core=o,l.F=1,l.G=2,l.S=4,l.P=8,l.B=16,l.W=32,l.U=64,l.R=128,e.exports=l},function(e,t,n){e.exports=n(97)()},function(e,t){var n={}.toString;e.exports=function(e){return n.call(e).slice(8,-1)}},function(e,t){e.exports=function(e){try{return!!e()}catch(t){return!0}}},function(e,t,n){"use strict";var r=n(72),o=n(85),a=n(21),i=n(30);e.exports=n(53)(Array,"Array",(function(e,t){this._t=i(e),this._i=0,this._k=t}),(function(){var e=this._t,t=this._k,n=this._i++;return!e||n>=e.length?(this._t=void 0,o(1)):o(0,"keys"==t?n:"values"==t?e[n]:[n,e[n]])}),"values"),a.Arguments=a.Array,r("keys"),r("values"),r("entries")},function(e,t){e.exports={}},function(e,t,n){"use strict";var r=n(26),o={};o[n(2)("toStringTag")]="z",o+""!="[object z]"&&n(14)(Object.prototype,"toString",(function(){return"[object "+r(this)+"]"}),!0)},function(e,t){e.exports=function(e){if(null==e)throw TypeError("Can't call method on "+e);return e}},function(e,t,n){var r=n(8),o=n(82),a=n(83),i=Object.defineProperty;t.f=n(11)?Object.defineProperty:function(e,t,n){if(r(e),t=a(t,!0),r(n),o)try{return i(e,t,n)}catch(c){}if("get"in n||"set"in n)throw TypeError("Accessors not supported!");return"value"in n&&(e[t]=n.value),e}},function(e,t){e.exports=function(e){if("function"!=typeof e)throw TypeError(e+" is not a function!");return e}},function(e,t,n){var r=n(18),o=n(2)("toStringTag"),a="Arguments"==r(function(){return arguments}());e.exports=function(e){var t,n,i;return void 0===e?"Undefined":null===e?"Null":"string"==typeof(n=function(e,t){try{return e[t]}catch(n){}}(t=Object(e),o))?n:a?r(t):"Object"==(i=r(t))&&"function"==typeof t.callee?"Arguments":i}},function(e,t){var n={}.hasOwnProperty;e.exports=function(e,t){return n.call(e,t)}},function(e,t,n){var r=n(25);e.exports=function(e,t,n){if(r(e),void 0===t)return e;switch(n){case 1:return function(n){return e.call(t,n)};case 2:return function(n,r){return e.call(t,n,r)};case 3:return function(n,r,o){return e.call(t,n,r,o)}}return function(){return e.apply(t,arguments)}}},function(e,t,n){for(var r=n(20),o=n(31),a=n(14),i=n(5),c=n(10),l=n(21),u=n(2),s=u("iterator"),f=u("toStringTag"),d=l.Array,p={CSSRuleList:!0,CSSStyleDeclaration:!1,CSSValueList:!1,ClientRectList:!1,DOMRectList:!1,DOMStringList:!1,DOMTokenList:!0,DataTransferItemList:!1,FileList:!1,HTMLAllCollection:!1,HTMLCollection:!1,HTMLFormElement:!1,HTMLSelectElement:!1,MediaList:!0,MimeTypeArray:!1,NamedNodeMap:!1,NodeList:!0,PaintRequestList:!1,Plugin:!1,PluginArray:!1,SVGLengthList:!1,SVGNumberList:!1,SVGPathSegList:!1,SVGPointList:!1,SVGStringList:!1,SVGTransformList:!1,SourceBufferList:!1,StyleSheetList:!0,TextTrackCueList:!1,TextTrackList:!1,TouchList:!1},m=o(p),h=0;h
                                                                                                                        '};function o(e,t,n){return en?n:e}function a(e){return 100*(-1+e)}n.configure=function(e){var t,n;for(t in e)void 0!==(n=e[t])&&e.hasOwnProperty(t)&&(r[t]=n);return this},n.status=null,n.set=function(e){var t=n.isStarted();e=o(e,r.minimum,1),n.status=1===e?null:e;var l=n.render(!t),u=l.querySelector(r.barSelector),s=r.speed,f=r.easing;return l.offsetWidth,i((function(t){""===r.positionUsing&&(r.positionUsing=n.getPositioningCSS()),c(u,function(e,t,n){var o;return(o="translate3d"===r.positionUsing?{transform:"translate3d("+a(e)+"%,0,0)"}:"translate"===r.positionUsing?{transform:"translate("+a(e)+"%,0)"}:{"margin-left":a(e)+"%"}).transition="all "+t+"ms "+n,o}(e,s,f)),1===e?(c(l,{transition:"none",opacity:1}),l.offsetWidth,setTimeout((function(){c(l,{transition:"all "+s+"ms linear",opacity:0}),setTimeout((function(){n.remove(),t()}),s)}),s)):setTimeout(t,s)})),this},n.isStarted=function(){return"number"==typeof n.status},n.start=function(){n.status||n.set(0);var e=function(){setTimeout((function(){n.status&&(n.trickle(),e())}),r.trickleSpeed)};return r.trickle&&e(),this},n.done=function(e){return e||n.status?n.inc(.3+.5*Math.random()).set(1):this},n.inc=function(e){var t=n.status;return t?("number"!=typeof e&&(e=(1-t)*o(Math.random()*t,.1,.95)),t=o(t+e,0,.994),n.set(t)):n.start()},n.trickle=function(){return n.inc(Math.random()*r.trickleRate)},e=0,t=0,n.promise=function(r){return r&&"resolved"!==r.state()?(0===t&&n.start(),e++,t++,r.always((function(){0==--t?(e=0,n.done()):n.set((e-t)/e)})),this):this},n.render=function(e){if(n.isRendered())return document.getElementById("nprogress");u(document.documentElement,"nprogress-busy");var t=document.createElement("div");t.id="nprogress",t.innerHTML=r.template;var o,i=t.querySelector(r.barSelector),l=e?"-100":a(n.status||0),s=document.querySelector(r.parent);return c(i,{transition:"all 0 linear",transform:"translate3d("+l+"%,0,0)"}),r.showSpinner||(o=t.querySelector(r.spinnerSelector))&&d(o),s!=document.body&&u(s,"nprogress-custom-parent"),s.appendChild(t),t},n.remove=function(){s(document.documentElement,"nprogress-busy"),s(document.querySelector(r.parent),"nprogress-custom-parent");var e=document.getElementById("nprogress");e&&d(e)},n.isRendered=function(){return!!document.getElementById("nprogress")},n.getPositioningCSS=function(){var e=document.body.style,t="WebkitTransform"in e?"Webkit":"MozTransform"in e?"Moz":"msTransform"in e?"ms":"OTransform"in e?"O":"";return t+"Perspective"in e?"translate3d":t+"Transform"in e?"translate":"margin"};var i=function(){var e=[];function t(){var n=e.shift();n&&n(t)}return function(n){e.push(n),1==e.length&&t()}}(),c=function(){var e=["Webkit","O","Moz","ms"],t={};function n(n){return n=n.replace(/^-ms-/,"ms-").replace(/-([\da-z])/gi,(function(e,t){return t.toUpperCase()})),t[n]||(t[n]=function(t){var n=document.body.style;if(t in n)return t;for(var r,o=e.length,a=t.charAt(0).toUpperCase()+t.slice(1);o--;)if((r=e[o]+a)in n)return r;return t}(n))}function r(e,t,r){t=n(t),e.style[t]=r}return function(e,t){var n,o,a=arguments;if(2==a.length)for(n in t)void 0!==(o=t[n])&&t.hasOwnProperty(n)&&r(e,n,o);else r(e,a[1],a[2])}}();function l(e,t){return("string"==typeof e?e:f(e)).indexOf(" "+t+" ")>=0}function u(e,t){var n=f(e),r=n+t;l(n,t)||(e.className=r.substring(1))}function s(e,t){var n,r=f(e);l(e,t)&&(n=r.replace(" "+t+" "," "),e.className=n.substring(1,n.length-1))}function f(e){return(" "+(e.className||"")+" ").replace(/\s+/gi," ")}function d(e){e&&e.parentNode&&e.parentNode.removeChild(e)}return n})?r.call(t,n,t,e):r)||(e.exports=o)},function(e,t,n){"use strict";n.d(t,"a",(function(){return f})),n.d(t,"b",(function(){return w}));var r=n(3);n.d(t,"c",(function(){return r.a})),n.d(t,"d",(function(){return r.f}));var o=n(6),a=n(0),i=n.n(a),c=n(7),l=(n(17),n(1)),u=n(9),s=n(4),f=function(e){function t(){for(var t,n=arguments.length,r=new Array(n),o=0;o0?o(r(e),9007199254740991):0}},function(e,t){var n=Math.ceil,r=Math.floor;e.exports=function(e){return isNaN(e=+e)?0:(e>0?r:n)(e)}},,function(e,t,n){var r=n(13),o=n(5),a=o["__core-js_shared__"]||(o["__core-js_shared__"]={});(e.exports=function(e,t){return a[e]||(a[e]=void 0!==t?t:{})})("versions",[]).push({version:r.version,mode:n(39)?"pure":"global",copyright:"\xa9 2019 Denis Pushkarev (zloirock.ru)"})},function(e,t){e.exports=!1},function(e,t){var n=0,r=Math.random();e.exports=function(e){return"Symbol(".concat(void 0===e?"":e,")_",(++n+r).toString(36))}},function(e,t,n){"use strict";var r,o,a=n(80),i=RegExp.prototype.exec,c=String.prototype.replace,l=i,u=(r=/a/,o=/b*/g,i.call(r,"a"),i.call(o,"a"),0!==r.lastIndex||0!==o.lastIndex),s=void 0!==/()??/.exec("")[1];(u||s)&&(l=function(e){var t,n,r,o,l=this;return s&&(n=new RegExp("^"+l.source+"$(?!\\s)",a.call(l))),u&&(t=l.lastIndex),r=i.call(l,e),u&&r&&(l.lastIndex=l.global?r.index+r[0].length:t),s&&r&&r.length>1&&c.call(r[0],n,(function(){for(o=1;o=u?e?"":void 0:(a=c.charCodeAt(l))<55296||a>56319||l+1===u||(i=c.charCodeAt(l+1))<56320||i>57343?e?c.charAt(l):a:e?c.slice(l,l+2):i-56320+(a-55296<<10)+65536}}},function(e,t){e.exports=function(e,t){return{enumerable:!(1&e),configurable:!(2&e),writable:!(4&e),value:t}}},function(e,t,n){"use strict";var r=n(39),o=n(16),a=n(14),i=n(10),c=n(21),l=n(87),u=n(44),s=n(92),f=n(2)("iterator"),d=!([].keys&&"next"in[].keys()),p=function(){return this};e.exports=function(e,t,n,m,h,g,v){l(n,t,m);var b,y,w,x=function(e){if(!d&&e in S)return S[e];switch(e){case"keys":case"values":return function(){return new n(this,e)}}return function(){return new n(this,e)}},k=t+" Iterator",E="values"==h,T=!1,S=e.prototype,C=S[f]||S["@@iterator"]||h&&S[h],_=C||x(h),P=h?E?x("entries"):_:void 0,j="Array"==t&&S.entries||C;if(j&&(w=s(j.call(new e)))!==Object.prototype&&w.next&&(u(w,k,!0),r||"function"==typeof w[f]||i(w,f,p)),E&&C&&"values"!==C.name&&(T=!0,_=function(){return C.call(this)}),r&&!v||!d&&!T&&S[f]||i(S,f,_),c[t]=_,c[k]=p,h)if(b={values:E?_:x("values"),keys:g?_:x("keys"),entries:P},v)for(y in b)y in S||a(S,y,b[y]);else o(o.P+o.F*(d||T),t,b);return b}},function(e,t){e.exports="constructor,hasOwnProperty,isPrototypeOf,propertyIsEnumerable,toLocaleString,toString,valueOf".split(",")},function(e,t,n){var r=n(5).document;e.exports=r&&r.documentElement},function(e,t,n){var r=n(49),o=n(31);n(93)("keys",(function(){return function(e){return o(r(e))}}))},function(e,t,n){"use strict";var r=n(15);t.a=r.b},function(e,t,n){"use strict";e.exports=n(100)},function(e,t,n){"use strict";var r=n(0),o=n.n(r);t.a=o.a.createContext({})},function(e,t,n){"use strict";n.r(t),t.default="undefined"==typeof window?null:{onRouteUpdate:function(e){var t=e.location;window.ga("set","page",t.pathname),window.ga("send","pageview")}}},function(e,t,n){"use strict";var r,o,a,i,c=n(39),l=n(5),u=n(28),s=n(26),f=n(16),d=n(12),p=n(25),m=n(103),h=n(104),g=n(50),v=n(62).set,b=n(109)(),y=n(63),w=n(110),x=n(111),k=n(112),E=l.TypeError,T=l.process,S=T&&T.versions,C=S&&S.v8||"",_=l.Promise,P="process"==s(T),j=function(){},O=o=y.f,L=!!function(){try{var e=_.resolve(1),t=(e.constructor={})[n(2)("species")]=function(e){e(j,j)};return(P||"function"==typeof PromiseRejectionEvent)&&e.then(j)instanceof t&&0!==C.indexOf("6.6")&&-1===x.indexOf("Chrome/66")}catch(r){}}(),N=function(e){var t;return!(!d(e)||"function"!=typeof(t=e.then))&&t},M=function(e,t){if(!e._n){e._n=!0;var n=e._c;b((function(){for(var r=e._v,o=1==e._s,a=0,i=function(t){var n,a,i,c=o?t.ok:t.fail,l=t.resolve,u=t.reject,s=t.domain;try{c?(o||(2==e._h&&I(e),e._h=1),!0===c?n=r:(s&&s.enter(),n=c(r),s&&(s.exit(),i=!0)),n===t.promise?u(E("Promise-chain cycle")):(a=N(n))?a.call(n,l,u):l(n)):u(r)}catch(f){s&&!i&&s.exit(),u(f)}};n.length>a;)i(n[a++]);e._c=[],e._n=!1,t&&!e._h&&R(e)}))}},R=function(e){v.call(l,(function(){var t,n,r,o=e._v,a=z(e);if(a&&(t=w((function(){P?T.emit("unhandledRejection",o,e):(n=l.onunhandledrejection)?n({promise:e,reason:o}):(r=l.console)&&r.error&&r.error("Unhandled promise rejection",o)})),e._h=P||z(e)?2:1),e._a=void 0,a&&t.e)throw t.v}))},z=function(e){return 1!==e._h&&0===(e._a||e._c).length},I=function(e){v.call(l,(function(){var t;P?T.emit("rejectionHandled",e):(t=l.onrejectionhandled)&&t({promise:e,reason:e._v})}))},A=function(e){var t=this;t._d||(t._d=!0,(t=t._w||t)._v=e,t._s=2,t._a||(t._a=t._c.slice()),M(t,!0))},U=function(e){var t,n=this;if(!n._d){n._d=!0,n=n._w||n;try{if(n===e)throw E("Promise can't be resolved itself");(t=N(e))?b((function(){var r={_w:n,_d:!1};try{t.call(e,u(U,r,1),u(A,r,1))}catch(o){A.call(r,o)}})):(n._v=e,n._s=1,M(n,!1))}catch(r){A.call({_w:n,_d:!1},r)}}};L||(_=function(e){m(this,_,"Promise","_h"),p(e),r.call(this);try{e(u(U,this,1),u(A,this,1))}catch(t){A.call(this,t)}},(r=function(e){this._c=[],this._a=void 0,this._s=0,this._d=!1,this._v=void 0,this._h=0,this._n=!1}).prototype=n(113)(_.prototype,{then:function(e,t){var n=O(g(this,_));return n.ok="function"!=typeof e||e,n.fail="function"==typeof t&&t,n.domain=P?T.domain:void 0,this._c.push(n),this._a&&this._a.push(n),this._s&&M(this,!1),n.promise},catch:function(e){return this.then(void 0,e)}}),a=function(){var e=new r;this.promise=e,this.resolve=u(U,e,1),this.reject=u(A,e,1)},y.f=O=function(e){return e===_||e===i?new a(e):o(e)}),f(f.G+f.W+f.F*!L,{Promise:_}),n(44)(_,"Promise"),n(114)("Promise"),i=n(13).Promise,f(f.S+f.F*!L,"Promise",{reject:function(e){var t=O(this);return(0,t.reject)(e),t.promise}}),f(f.S+f.F*(c||!L),"Promise",{resolve:function(e){return k(c&&this===i?_:this,e)}}),f(f.S+f.F*!(L&&n(115)((function(e){_.all(e).catch(j)}))),"Promise",{all:function(e){var t=this,n=O(t),r=n.resolve,o=n.reject,a=w((function(){var n=[],a=0,i=1;h(e,!1,(function(e){var c=a++,l=!1;n.push(void 0),i++,t.resolve(e).then((function(e){l||(l=!0,n[c]=e,--i||r(n))}),o)})),--i||r(n)}));return a.e&&o(a.v),n.promise},race:function(e){var t=this,n=O(t),r=n.reject,o=w((function(){h(e,!1,(function(e){t.resolve(e).then(n.resolve,r)}))}));return o.e&&r(o.v),n.promise}})},function(e,t,n){var r,o,a,i=n(28),c=n(108),l=n(55),u=n(42),s=n(5),f=s.process,d=s.setImmediate,p=s.clearImmediate,m=s.MessageChannel,h=s.Dispatch,g=0,v={},b=function(){var e=+this;if(v.hasOwnProperty(e)){var t=v[e];delete v[e],t()}},y=function(e){b.call(e.data)};d&&p||(d=function(e){for(var t=[],n=1;arguments.length>n;)t.push(arguments[n++]);return v[++g]=function(){c("function"==typeof e?e:Function(e),t)},r(g),g},p=function(e){delete v[e]},"process"==n(18)(f)?r=function(e){f.nextTick(i(b,e,1))}:h&&h.now?r=function(e){h.now(i(b,e,1))}:m?(a=(o=new m).port2,o.port1.onmessage=y,r=i(a.postMessage,a,1)):s.addEventListener&&"function"==typeof postMessage&&!s.importScripts?(r=function(e){s.postMessage(e+"","*")},s.addEventListener("message",y,!1)):r="onreadystatechange"in u("script")?function(e){l.appendChild(u("script")).onreadystatechange=function(){l.removeChild(this),b.call(e)}}:function(e){setTimeout(i(b,e,1),0)}),e.exports={set:d,clear:p}},function(e,t,n){"use strict";var r=n(25);function o(e){var t,n;this.promise=new e((function(e,r){if(void 0!==t||void 0!==n)throw TypeError("Bad Promise constructor");t=e,n=r})),this.resolve=r(t),this.reject=r(n)}e.exports.f=function(e){return new o(e)}},function(e,t,n){"use strict";!function e(){if("undefined"!=typeof __REACT_DEVTOOLS_GLOBAL_HOOK__&&"function"==typeof __REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE){0;try{__REACT_DEVTOOLS_GLOBAL_HOOK__.checkDCE(e)}catch(t){console.error(t)}}}(),e.exports=n(77)},function(e,t,n){"use strict";(function(t){var n="__global_unique_id__";e.exports=function(){return t[n]=(t[n]||0)+1}}).call(this,n(74))},function(e,t,n){"use strict";var r=n(58),o={childContextTypes:!0,contextType:!0,contextTypes:!0,defaultProps:!0,displayName:!0,getDefaultProps:!0,getDerivedStateFromError:!0,getDerivedStateFromProps:!0,mixins:!0,propTypes:!0,type:!0},a={name:!0,length:!0,prototype:!0,caller:!0,callee:!0,arguments:!0,arity:!0},i={$$typeof:!0,compare:!0,defaultProps:!0,displayName:!0,propTypes:!0,type:!0},c={};function l(e){return r.isMemo(e)?i:c[e.$$typeof]||o}c[r.ForwardRef]={$$typeof:!0,render:!0,defaultProps:!0,displayName:!0,propTypes:!0},c[r.Memo]=i;var u=Object.defineProperty,s=Object.getOwnPropertyNames,f=Object.getOwnPropertySymbols,d=Object.getOwnPropertyDescriptor,p=Object.getPrototypeOf,m=Object.prototype;e.exports=function e(t,n,r){if("string"!=typeof n){if(m){var o=p(n);o&&o!==m&&e(t,o,r)}var i=s(n);f&&(i=i.concat(f(n)));for(var c=l(t),h=l(n),g=0;g1||"".split(/.?/).length?function(e,t){var o=String(this);if(void 0===e&&0===t)return[];if(!r(e))return n.call(o,e,t);for(var a,i,c,l=[],s=(e.ignoreCase?"i":"")+(e.multiline?"m":"")+(e.unicode?"u":"")+(e.sticky?"y":""),f=0,p=void 0===t?4294967295:t>>>0,m=new RegExp(e.source,s+"g");(a=u.call(m,o))&&!((i=m.lastIndex)>f&&(l.push(o.slice(f,a.index)),a.length>1&&a.index=p));)m.lastIndex===a.index&&m.lastIndex++;return f===o.length?!c&&m.test("")||l.push(""):l.push(o.slice(f)),l.length>p?l.slice(0,p):l}:"0".split(void 0,0).length?function(e,t){return void 0===e&&0===t?[]:n.call(this,e,t)}:n,[function(n,r){var o=e(this),a=null==n?void 0:n[t];return void 0!==a?a.call(n,o,r):m.call(String(o),n,r)},function(e,t){var r=s(m,e,this,t,m!==n);if(r.done)return r.value;var u=o(e),d=String(this),h=a(u,RegExp),g=u.unicode,v=(u.ignoreCase?"i":"")+(u.multiline?"m":"")+(u.unicode?"u":"")+(p?"y":"g"),b=new h(p?u:"^(?:"+u.source+")",v),y=void 0===t?4294967295:t>>>0;if(0===y)return[];if(0===d.length)return null===l(b,d)?[d]:[];for(var w=0,x=0,k=[];x")})),f=function(){var e=/(?:)/,t=e.exec;e.exec=function(){return t.apply(this,arguments)};var n="ab".split(e);return 2===n.length&&"a"===n[0]&&"b"===n[1]}();e.exports=function(e,t,n){var d=c(e),p=!a((function(){var t={};return t[d]=function(){return 7},7!=""[e](t)})),m=p?!a((function(){var t=!1,n=/a/;return n.exec=function(){return t=!0,null},"split"===e&&(n.constructor={},n.constructor[u]=function(){return n}),n[d](""),!t})):void 0;if(!p||!m||"replace"===e&&!s||"split"===e&&!f){var h=/./[d],g=n(i,d,""[e],(function(e,t,n,r,o){return t.exec===l?p&&!o?{done:!0,value:h.call(t,n,r)}:{done:!0,value:e.call(n,t,r)}:{done:!1}})),v=g[0],b=g[1];r(String.prototype,e,v),o(RegExp.prototype,d,2==t?function(e,t){return b.call(e,this,t)}:function(e){return b.call(e,this)})}}},function(e,t,n){var r=n(12),o=n(18),a=n(2)("match");e.exports=function(e){var t;return r(e)&&(void 0!==(t=e[a])?!!t:"RegExp"==o(e))}},function(e,t,n){var r=n(2)("unscopables"),o=Array.prototype;null==o[r]&&n(10)(o,r,{}),e.exports=function(e){o[r][e]=!0}},function(e,t,n){var r=n(30),o=n(35),a=n(91);e.exports=function(e){return function(t,n,i){var c,l=r(t),u=o(l.length),s=a(i,u);if(e&&n!=n){for(;u>s;)if((c=l[s++])!=c)return!0}else for(;u>s;s++)if((e||s in l)&&l[s]===n)return e||s||0;return!e&&-1}}},function(e,t){var n;n=function(){return this}();try{n=n||new Function("return this")()}catch(r){"object"==typeof window&&(n=window)}e.exports=n},function(e,t,n){e.exports=n(121)},function(e,t,n){"use strict";var r=n(48),o="function"==typeof Symbol&&Symbol.for,a=o?Symbol.for("react.element"):60103,i=o?Symbol.for("react.portal"):60106,c=o?Symbol.for("react.fragment"):60107,l=o?Symbol.for("react.strict_mode"):60108,u=o?Symbol.for("react.profiler"):60114,s=o?Symbol.for("react.provider"):60109,f=o?Symbol.for("react.context"):60110,d=o?Symbol.for("react.forward_ref"):60112,p=o?Symbol.for("react.suspense"):60113;o&&Symbol.for("react.suspense_list");var m=o?Symbol.for("react.memo"):60115,h=o?Symbol.for("react.lazy"):60116;o&&Symbol.for("react.fundamental"),o&&Symbol.for("react.responder"),o&&Symbol.for("react.scope");var g="function"==typeof Symbol&&Symbol.iterator;function v(e){for(var t="https://reactjs.org/docs/error-decoder.html?invariant="+e,n=1;nL.length&&L.push(e)}function R(e,t,n){return null==e?0:function e(t,n,r,o){var c=typeof t;"undefined"!==c&&"boolean"!==c||(t=null);var l=!1;if(null===t)l=!0;else switch(c){case"string":case"number":l=!0;break;case"object":switch(t.$$typeof){case a:case i:l=!0}}if(l)return r(o,t,""===n?"."+z(t,0):n),1;if(l=0,n=""===n?".":n+":",Array.isArray(t))for(var u=0;u