forked from loafle/openapi-generator-original
Deploy website version based on aa7cd4f5af
This commit is contained in:
wing328
@@ -1,151 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>generators/README · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<!-- Generate with: openapi-generator list --github-nested-index -->"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="generators/README · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="<!-- Generate with: openapi-generator list --github-nested-index -->"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">generators/README</h1></header><article><div><span><!-- Generate with: openapi-generator list --github-nested-index -->
|
||||
The following generators are available:
|
||||
<h2><a class="anchor" aria-hidden="true" id="client-generators"></a><a href="#client-generators" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>CLIENT generators</h2>
|
||||
<ul>
|
||||
<li><a href="/docs/generators/ada">ada</a></li>
|
||||
<li><a href="/docs/generators/android">android</a></li>
|
||||
<li><a href="/docs/generators/apex">apex</a></li>
|
||||
<li><a href="/docs/generators/bash">bash</a></li>
|
||||
<li><a href="/docs/generators/c">c</a></li>
|
||||
<li><a href="/docs/generators/clojure">clojure</a></li>
|
||||
<li><a href="/docs/generators/cpp-qt5-client">cpp-qt5-client</a></li>
|
||||
<li><a href="/docs/generators/cpp-restsdk">cpp-restsdk</a></li>
|
||||
<li><a href="/docs/generators/cpp-tizen">cpp-tizen</a></li>
|
||||
<li><a href="/docs/generators/csharp">csharp</a></li>
|
||||
<li><a href="/docs/generators/csharp-netcore">csharp-netcore</a></li>
|
||||
<li><a href="/docs/generators/dart">dart</a></li>
|
||||
<li><a href="/docs/generators/dart-dio">dart-dio</a></li>
|
||||
<li><a href="/docs/generators/dart-jaguar">dart-jaguar</a></li>
|
||||
<li><a href="/docs/generators/eiffel">eiffel</a></li>
|
||||
<li><a href="/docs/generators/elixir">elixir</a></li>
|
||||
<li><a href="/docs/generators/elm">elm</a></li>
|
||||
<li><a href="/docs/generators/erlang-client">erlang-client</a></li>
|
||||
<li><a href="/docs/generators/erlang-proper">erlang-proper</a></li>
|
||||
<li><a href="/docs/generators/flash">flash</a></li>
|
||||
<li><a href="/docs/generators/go">go</a></li>
|
||||
<li><a href="/docs/generators/go-experimental">go-experimental (experimental)</a></li>
|
||||
<li><a href="/docs/generators/groovy">groovy</a></li>
|
||||
<li><a href="/docs/generators/haskell-http-client">haskell-http-client</a></li>
|
||||
<li><a href="/docs/generators/java">java</a></li>
|
||||
<li><a href="/docs/generators/javascript">javascript</a></li>
|
||||
<li><a href="/docs/generators/javascript-closure-angular">javascript-closure-angular</a></li>
|
||||
<li><a href="/docs/generators/javascript-flowtyped">javascript-flowtyped</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-cxf-client">jaxrs-cxf-client</a></li>
|
||||
<li><a href="/docs/generators/jmeter">jmeter</a></li>
|
||||
<li><a href="/docs/generators/kotlin">kotlin</a></li>
|
||||
<li><a href="/docs/generators/lua">lua</a></li>
|
||||
<li><a href="/docs/generators/nim">nim (beta)</a></li>
|
||||
<li><a href="/docs/generators/objc">objc</a></li>
|
||||
<li><a href="/docs/generators/ocaml">ocaml</a></li>
|
||||
<li><a href="/docs/generators/perl">perl</a></li>
|
||||
<li><a href="/docs/generators/php">php</a></li>
|
||||
<li><a href="/docs/generators/powershell">powershell</a></li>
|
||||
<li><a href="/docs/generators/python">python</a></li>
|
||||
<li><a href="/docs/generators/python-experimental">python-experimental (experimental)</a></li>
|
||||
<li><a href="/docs/generators/r">r</a></li>
|
||||
<li><a href="/docs/generators/ruby">ruby</a></li>
|
||||
<li><a href="/docs/generators/rust">rust</a></li>
|
||||
<li><a href="/docs/generators/scala-akka">scala-akka</a></li>
|
||||
<li><a href="/docs/generators/scala-gatling">scala-gatling</a></li>
|
||||
<li><a href="/docs/generators/scalaz">scalaz</a></li>
|
||||
<li><a href="/docs/generators/swift4">swift4</a></li>
|
||||
<li><a href="/docs/generators/swift5">swift5 (beta)</a></li>
|
||||
<li><a href="/docs/generators/typescript-angular">typescript-angular</a></li>
|
||||
<li><a href="/docs/generators/typescript-angularjs">typescript-angularjs</a></li>
|
||||
<li><a href="/docs/generators/typescript-aurelia">typescript-aurelia</a></li>
|
||||
<li><a href="/docs/generators/typescript-axios">typescript-axios</a></li>
|
||||
<li><a href="/docs/generators/typescript-fetch">typescript-fetch</a></li>
|
||||
<li><a href="/docs/generators/typescript-inversify">typescript-inversify</a></li>
|
||||
<li><a href="/docs/generators/typescript-jquery">typescript-jquery</a></li>
|
||||
<li><a href="/docs/generators/typescript-node">typescript-node</a></li>
|
||||
<li><a href="/docs/generators/typescript-redux-query">typescript-redux-query</a></li>
|
||||
<li><a href="/docs/generators/typescript-rxjs">typescript-rxjs</a></li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="server-generators"></a><a href="#server-generators" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>SERVER generators</h2>
|
||||
<ul>
|
||||
<li><a href="/docs/generators/ada-server">ada-server</a></li>
|
||||
<li><a href="/docs/generators/aspnetcore">aspnetcore</a></li>
|
||||
<li><a href="/docs/generators/cpp-pistache-server">cpp-pistache-server</a></li>
|
||||
<li><a href="/docs/generators/cpp-qt5-qhttpengine-server">cpp-qt5-qhttpengine-server</a></li>
|
||||
<li><a href="/docs/generators/cpp-restbed-server">cpp-restbed-server</a></li>
|
||||
<li><a href="/docs/generators/csharp-nancyfx">csharp-nancyfx</a></li>
|
||||
<li><a href="/docs/generators/erlang-server">erlang-server</a></li>
|
||||
<li><a href="/docs/generators/fsharp-functions">fsharp-functions (beta)</a></li>
|
||||
<li><a href="/docs/generators/fsharp-giraffe-server">fsharp-giraffe-server (beta)</a></li>
|
||||
<li><a href="/docs/generators/go-gin-server">go-gin-server</a></li>
|
||||
<li><a href="/docs/generators/go-server">go-server</a></li>
|
||||
<li><a href="/docs/generators/graphql-nodejs-express-server">graphql-nodejs-express-server</a></li>
|
||||
<li><a href="/docs/generators/haskell">haskell</a></li>
|
||||
<li><a href="/docs/generators/java-inflector">java-inflector</a></li>
|
||||
<li><a href="/docs/generators/java-msf4j">java-msf4j</a></li>
|
||||
<li><a href="/docs/generators/java-pkmst">java-pkmst</a></li>
|
||||
<li><a href="/docs/generators/java-play-framework">java-play-framework</a></li>
|
||||
<li><a href="/docs/generators/java-undertow-server">java-undertow-server</a></li>
|
||||
<li><a href="/docs/generators/java-vertx">java-vertx</a></li>
|
||||
<li><a href="/docs/generators/java-vertx-web">java-vertx-web (beta)</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-cxf">jaxrs-cxf</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-cxf-cdi">jaxrs-cxf-cdi</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-cxf-extended">jaxrs-cxf-extended</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-jersey">jaxrs-jersey</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-resteasy">jaxrs-resteasy</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-resteasy-eap">jaxrs-resteasy-eap</a></li>
|
||||
<li><a href="/docs/generators/jaxrs-spec">jaxrs-spec</a></li>
|
||||
<li><a href="/docs/generators/kotlin-server">kotlin-server</a></li>
|
||||
<li><a href="/docs/generators/kotlin-spring">kotlin-spring</a></li>
|
||||
<li><a href="/docs/generators/kotlin-vertx">kotlin-vertx (beta)</a></li>
|
||||
<li><a href="/docs/generators/nodejs-express-server">nodejs-express-server (beta)</a></li>
|
||||
<li><a href="/docs/generators/php-laravel">php-laravel</a></li>
|
||||
<li><a href="/docs/generators/php-lumen">php-lumen</a></li>
|
||||
<li><a href="/docs/generators/php-silex">php-silex</a></li>
|
||||
<li><a href="/docs/generators/php-slim4">php-slim4</a></li>
|
||||
<li><a href="/docs/generators/php-symfony">php-symfony</a></li>
|
||||
<li><a href="/docs/generators/php-ze-ph">php-ze-ph</a></li>
|
||||
<li><a href="/docs/generators/python-aiohttp">python-aiohttp</a></li>
|
||||
<li><a href="/docs/generators/python-blueplanet">python-blueplanet</a></li>
|
||||
<li><a href="/docs/generators/python-flask">python-flask</a></li>
|
||||
<li><a href="/docs/generators/ruby-on-rails">ruby-on-rails</a></li>
|
||||
<li><a href="/docs/generators/ruby-sinatra">ruby-sinatra</a></li>
|
||||
<li><a href="/docs/generators/rust-server">rust-server</a></li>
|
||||
<li><a href="/docs/generators/scala-finch">scala-finch</a></li>
|
||||
<li><a href="/docs/generators/scala-lagom-server">scala-lagom-server</a></li>
|
||||
<li><a href="/docs/generators/scala-play-server">scala-play-server</a></li>
|
||||
<li><a href="/docs/generators/scalatra">scalatra</a></li>
|
||||
<li><a href="/docs/generators/spring">spring</a></li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="documentation-generators"></a><a href="#documentation-generators" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>DOCUMENTATION generators</h2>
|
||||
<ul>
|
||||
<li><a href="/docs/generators/asciidoc">asciidoc</a></li>
|
||||
<li><a href="/docs/generators/cwiki">cwiki</a></li>
|
||||
<li><a href="/docs/generators/dynamic-html">dynamic-html</a></li>
|
||||
<li><a href="/docs/generators/html">html</a></li>
|
||||
<li><a href="/docs/generators/html2">html2</a></li>
|
||||
<li><a href="/docs/generators/markdown">markdown (beta)</a></li>
|
||||
<li><a href="/docs/generators/openapi">openapi</a></li>
|
||||
<li><a href="/docs/generators/openapi-yaml">openapi-yaml</a></li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="schema-generators"></a><a href="#schema-generators" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>SCHEMA generators</h2>
|
||||
<ul>
|
||||
<li><a href="/docs/generators/avro-schema">avro-schema (beta)</a></li>
|
||||
<li><a href="/docs/generators/mysql-schema">mysql-schema</a></li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="config-generators"></a><a href="#config-generators" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>CONFIG generators</h2>
|
||||
<ul>
|
||||
<li><a href="/docs/generators/apache2">apache2</a></li>
|
||||
<li><a href="/docs/generators/graphql-schema">graphql-schema</a></li>
|
||||
<li><a href="/docs/generators/protobuf-schema">protobuf-schema (beta)</a></li>
|
||||
</ul>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/1/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#client-generators">CLIENT generators</a></li><li><a href="#server-generators">SERVER generators</a></li><li><a href="#documentation-generators">DOCUMENTATION generators</a></li><li><a href="#schema-generators">SCHEMA generators</a></li><li><a href="#config-generators">CONFIG generators</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,266 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for ada-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for ada-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for ada-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>projectName</td><td>GNAT project name</td><td></td><td>defaultProject</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Character</li>
|
||||
<li>Integer</li>
|
||||
<li>boolean</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abort</li>
|
||||
<li>abs</li>
|
||||
<li>abstract</li>
|
||||
<li>accept</li>
|
||||
<li>access</li>
|
||||
<li>aliased</li>
|
||||
<li>all</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>at</li>
|
||||
<li>begin</li>
|
||||
<li>body</li>
|
||||
<li>case</li>
|
||||
<li>constant</li>
|
||||
<li>declare</li>
|
||||
<li>delay</li>
|
||||
<li>digits</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elsif</li>
|
||||
<li>end</li>
|
||||
<li>entry</li>
|
||||
<li>exception</li>
|
||||
<li>exit</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>generic</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>limited</li>
|
||||
<li>loop</li>
|
||||
<li>mod</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>others</li>
|
||||
<li>out</li>
|
||||
<li>overriding</li>
|
||||
<li>package</li>
|
||||
<li>pragma</li>
|
||||
<li>private</li>
|
||||
<li>procedure</li>
|
||||
<li>protected</li>
|
||||
<li>raise</li>
|
||||
<li>range</li>
|
||||
<li>record</li>
|
||||
<li>rem</li>
|
||||
<li>renames</li>
|
||||
<li>requeue</li>
|
||||
<li>return</li>
|
||||
<li>reverse</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>some</li>
|
||||
<li>subtype</li>
|
||||
<li>synchronized</li>
|
||||
<li>tagged</li>
|
||||
<li>task</li>
|
||||
<li>terminate</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>until</li>
|
||||
<li>use</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,266 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for ada · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for ada · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for ada</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>projectName</td><td>GNAT project name</td><td></td><td>defaultProject</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Character</li>
|
||||
<li>Integer</li>
|
||||
<li>boolean</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abort</li>
|
||||
<li>abs</li>
|
||||
<li>abstract</li>
|
||||
<li>accept</li>
|
||||
<li>access</li>
|
||||
<li>aliased</li>
|
||||
<li>all</li>
|
||||
<li>and</li>
|
||||
<li>array</li>
|
||||
<li>at</li>
|
||||
<li>begin</li>
|
||||
<li>body</li>
|
||||
<li>case</li>
|
||||
<li>constant</li>
|
||||
<li>declare</li>
|
||||
<li>delay</li>
|
||||
<li>digits</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elsif</li>
|
||||
<li>end</li>
|
||||
<li>entry</li>
|
||||
<li>exception</li>
|
||||
<li>exit</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>generic</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>limited</li>
|
||||
<li>loop</li>
|
||||
<li>mod</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>others</li>
|
||||
<li>out</li>
|
||||
<li>overriding</li>
|
||||
<li>package</li>
|
||||
<li>pragma</li>
|
||||
<li>private</li>
|
||||
<li>procedure</li>
|
||||
<li>protected</li>
|
||||
<li>raise</li>
|
||||
<li>range</li>
|
||||
<li>record</li>
|
||||
<li>rem</li>
|
||||
<li>renames</li>
|
||||
<li>requeue</li>
|
||||
<li>return</li>
|
||||
<li>reverse</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>some</li>
|
||||
<li>subtype</li>
|
||||
<li>synchronized</li>
|
||||
<li>tagged</li>
|
||||
<li>task</li>
|
||||
<li>terminate</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>until</li>
|
||||
<li>use</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,289 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for android · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for android · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for android</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>androidBuildToolsVersion</td><td>buildToolsVersion version for use in the generated build.gradle</td><td></td><td>null</td></tr>
|
||||
<tr><td>androidGradleVersion</td><td>gradleVersion version for use in the generated build.gradle</td><td></td><td>null</td></tr>
|
||||
<tr><td>androidSdkVersion</td><td>compileSdkVersion version for use in the generated build.gradle</td><td></td><td>null</td></tr>
|
||||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId for use in the generated build.gradle and pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version for use in the generated build.gradle and pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>groupId</td><td>groupId for use in the generated build.gradle and pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>library</td><td>library template (sub-template) to use</td><td><dl><dt><strong>volley</strong></dt><dd>HTTP client: Volley 1.0.19 (default)</dd><dt><strong>httpclient</strong></dt><dd>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.</dd><dl></td><td>null</td></tr>
|
||||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>useAndroidMavenGradlePlugin</td><td>A flag to toggle android-maven gradle plugin.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ArrayList</td></tr>
|
||||
<tr><td>map</td><td>HashMap</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>apiinvoker</li>
|
||||
<li>assert</li>
|
||||
<li>authnames</li>
|
||||
<li>basepath</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localvarbuilder</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>localvarpath</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>localvarresponse</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>strictfp</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>transient</li>
|
||||
<li>try</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,202 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for apache2 · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for apache2 · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for apache2</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>userInfoPath</td><td>Path to the user and group files</td><td></td><td>null</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,339 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for apex · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for apex · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for apex</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiVersion</td><td>The Metadata API version number to use for components in this package.</td><td></td><td>null</td></tr>
|
||||
<tr><td>buildMethod</td><td>The build method for this package.</td><td></td><td>null</td></tr>
|
||||
<tr><td>classPrefix</td><td>Prefix for generated classes. Set this to avoid overwriting existing classes in your org.</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>namedCredential</td><td>The named credential name for the HTTP callouts</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Map</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Blob</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>Datetime</li>
|
||||
<li>Decimal</li>
|
||||
<li>Double</li>
|
||||
<li>ID</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>Time</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>activate</li>
|
||||
<li>and</li>
|
||||
<li>any</li>
|
||||
<li>array</li>
|
||||
<li>as</li>
|
||||
<li>asc</li>
|
||||
<li>autonomous</li>
|
||||
<li>begin</li>
|
||||
<li>bigdecimal</li>
|
||||
<li>blob</li>
|
||||
<li>break</li>
|
||||
<li>bulk</li>
|
||||
<li>by</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>cast</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>collect</li>
|
||||
<li>commit</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>convertcurrency</li>
|
||||
<li>currency</li>
|
||||
<li>date</li>
|
||||
<li>datetime</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>desc</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>exception</li>
|
||||
<li>exit</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>from</li>
|
||||
<li>future</li>
|
||||
<li>global</li>
|
||||
<li>goto</li>
|
||||
<li>group</li>
|
||||
<li>having</li>
|
||||
<li>hint</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inner</li>
|
||||
<li>insert</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>into</li>
|
||||
<li>join</li>
|
||||
<li>last_90_days</li>
|
||||
<li>last_month</li>
|
||||
<li>last_n_days</li>
|
||||
<li>last_week</li>
|
||||
<li>like</li>
|
||||
<li>limit</li>
|
||||
<li>list</li>
|
||||
<li>long</li>
|
||||
<li>loop</li>
|
||||
<li>map</li>
|
||||
<li>merge</li>
|
||||
<li>new</li>
|
||||
<li>next_90_days</li>
|
||||
<li>next_month</li>
|
||||
<li>next_n_days</li>
|
||||
<li>next_week</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>nulls</li>
|
||||
<li>number</li>
|
||||
<li>object</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>or</li>
|
||||
<li>outer</li>
|
||||
<li>override</li>
|
||||
<li>package</li>
|
||||
<li>parallel</li>
|
||||
<li>pragma</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>retrieve</li>
|
||||
<li>return</li>
|
||||
<li>returning</li>
|
||||
<li>rollback</li>
|
||||
<li>savepoint</li>
|
||||
<li>search</li>
|
||||
<li>select</li>
|
||||
<li>set</li>
|
||||
<li>short</li>
|
||||
<li>sort</li>
|
||||
<li>stat</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>system</li>
|
||||
<li>testmethod</li>
|
||||
<li>then</li>
|
||||
<li>this</li>
|
||||
<li>this_month</li>
|
||||
<li>this_week</li>
|
||||
<li>throw</li>
|
||||
<li>time</li>
|
||||
<li>today</li>
|
||||
<li>tolabel</li>
|
||||
<li>tomorrow</li>
|
||||
<li>transaction</li>
|
||||
<li>trigger</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>type</li>
|
||||
<li>undelete</li>
|
||||
<li>update</li>
|
||||
<li>upsert</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>webservice</li>
|
||||
<li>when</li>
|
||||
<li>where</li>
|
||||
<li>while</li>
|
||||
<li>yesterday</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,198 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for asciidoc · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for asciidoc · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for asciidoc</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>appDescription</td><td>description of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>appName</td><td>short name of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>headerAttributes</td><td>generation of asciidoc header meta data attributes (set to false to suppress, default: true)</td><td></td><td>true</td></tr>
|
||||
<tr><td>infoEmail</td><td>an email address to contact for inquiries about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoUrl</td><td>a URL where users can get more information about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseInfo</td><td>a short description of the license</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseUrl</td><td>a URL pointing to the full license</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>snippetDir</td><td>path with includable markup snippets (e.g. test output generated by restdoc, default: .)</td><td></td><td>.</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>specDir</td><td>path with includable markup spec files (e.g. handwritten additional docs, default: ..)</td><td></td><td>..</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,344 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for aspnetcore · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for aspnetcore · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for aspnetcore</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>aspnetCoreVersion</td><td>ASP.NET Core version: 3.0 (preview4 only), 2.2, 2.1, 2.0 (deprecated)</td><td></td><td>2.2</td></tr>
|
||||
<tr><td>buildTarget</td><td>Target to build an application or library</td><td></td><td>program</td></tr>
|
||||
<tr><td>classModifier</td><td>Class Modifier can be empty, abstract</td><td></td><td></td></tr>
|
||||
<tr><td>compatibilityVersion</td><td>ASP.Net Core CompatibilityVersion</td><td></td><td>Version_2_2</td></tr>
|
||||
<tr><td>enumNameSuffix</td><td>Suffix that will be appended to all enum names.</td><td></td><td>Enum</td></tr>
|
||||
<tr><td>enumValueSuffix</td><td>Suffix that will be appended to all enum values.</td><td></td><td>Enum</td></tr>
|
||||
<tr><td>generateBody</td><td>Generates method body.</td><td></td><td>true</td></tr>
|
||||
<tr><td>isLibrary</td><td>Is the build a library</td><td></td><td>false</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>NoLicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://localhost">http://localhost</a></td></tr>
|
||||
<tr><td>modelClassModifier</td><td>Model Class Modifier can be nothing or partial</td><td></td><td>partial</td></tr>
|
||||
<tr><td>newtonsoftVersion</td><td>Version for Microsoft.AspNetCore.Mvc.NewtonsoftJson for ASP.NET Core 3.0+</td><td></td><td>3.0.0-preview5-19227-01</td></tr>
|
||||
<tr><td>operationIsAsync</td><td>Set methods to async or sync (default).</td><td></td><td>false</td></tr>
|
||||
<tr><td>operationModifier</td><td>Operation Modifier can be virtual, abstract or partial</td><td></td><td>virtual</td></tr>
|
||||
<tr><td>operationResultTask</td><td>Set methods result to Task<>.</td><td></td><td>false</td></tr>
|
||||
<tr><td>packageAuthors</td><td>Specifies Authors property in the .NET Core project file.</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>packageCopyright</td><td>Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>No Copyright</td></tr>
|
||||
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>C# package name (convention: Title.Case).</td><td></td><td>Org.OpenAPITools</td></tr>
|
||||
<tr><td>packageTitle</td><td>Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>OpenAPI Library</td></tr>
|
||||
<tr><td>packageVersion</td><td>C# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>returnICollection</td><td>Return ICollection<T> instead of the concrete type.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
|
||||
<tr><td>swashbuckleVersion</td><td>Swashbucke version: 3.0.0, 4.0.0</td><td></td><td>3.0.0</td></tr>
|
||||
<tr><td>useCollection</td><td>Deserialize array types to Collection<T> instead of List<T>.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useDateTimeOffset</td><td>Use DateTimeOffset to model date-time properties</td><td></td><td>false</td></tr>
|
||||
<tr><td>useDefaultRouting</td><td>Use default routing for the ASP.NET Core version. For 3.0 turn off default because it is not yet supported.</td><td></td><td>true</td></tr>
|
||||
<tr><td>useFrameworkReference</td><td>Use frameworkReference for ASP.NET Core 3.0+ and PackageReference ASP.NET Core 2.2 or earlier.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useNewtonsoft</td><td>Uses the Newtonsoft JSON library.</td><td></td><td>true</td></tr>
|
||||
<tr><td>useSwashbuckle</td><td>Uses the Swashbuckle.AspNetCore NuGet package for documentation.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>list</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Dictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>var</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,203 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for avro-schema · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for avro-schema · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for avro-schema</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageName</td><td>package for generated classes (where supported)</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>Array</td></tr>
|
||||
<tr><td>list</td><td>Array</td></tr>
|
||||
<tr><td>map</td><td>Object</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>BigDecimal</li>
|
||||
<li>DateTime</li>
|
||||
<li>UUID</li>
|
||||
<li>boolean</li>
|
||||
<li>bytes</li>
|
||||
<li>date</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>integer</li>
|
||||
<li>long</li>
|
||||
<li>null</li>
|
||||
<li>number</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✗</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,232 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for bash · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for bash · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for bash</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiKeyAuthEnvironmentVariable</td><td>Name of environment variable where API key can be defined (e.g. PETSTORE_APIKEY='kjhasdGASDa5asdASD')</td><td></td><td>false</td></tr>
|
||||
<tr><td>basicAuthEnvironmentVariable</td><td>Name of environment variable where username and password can be defined (e.g. PETSTORE_CREDS='username:password')</td><td></td><td>null</td></tr>
|
||||
<tr><td>curlOptions</td><td>Default cURL options</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>generateBashCompletion</td><td>Whether to generate the Bash completion script</td><td></td><td>false</td></tr>
|
||||
<tr><td>generateZshCompletion</td><td>Whether to generate the Zsh completion script</td><td></td><td>false</td></tr>
|
||||
<tr><td>hostEnvironmentVariable</td><td>Name of environment variable where host can be defined (e.g. PETSTORE_HOST='<a href="http://api.openapitools.org:8080">http://api.openapitools.org:8080</a>')</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>processMarkdown</td><td>Convert all Markdown Markup into terminal formatting</td><td></td><td>false</td></tr>
|
||||
<tr><td>scriptName</td><td>The name of the script that will be generated (e.g. petstore-cli)</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>array</li>
|
||||
<li>binary</li>
|
||||
<li>boolean</li>
|
||||
<li>float</li>
|
||||
<li>integer</li>
|
||||
<li>map</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>case</li>
|
||||
<li>do</li>
|
||||
<li>done</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>esac</li>
|
||||
<li>fi</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>select</li>
|
||||
<li>then</li>
|
||||
<li>time</li>
|
||||
<li>until</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,241 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for c · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for c · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for c</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Object</li>
|
||||
<li>binary_t*</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>list</li>
|
||||
<li>list_t*</li>
|
||||
<li>long</li>
|
||||
<li>short</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>_alignas</li>
|
||||
<li>_alignof</li>
|
||||
<li>_atomic</li>
|
||||
<li>_bool</li>
|
||||
<li>_complex</li>
|
||||
<li>_generic</li>
|
||||
<li>_imaginary</li>
|
||||
<li>_noreturn</li>
|
||||
<li>_static_assert</li>
|
||||
<li>_thread_local</li>
|
||||
<li>auto</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>char</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extern</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>register</li>
|
||||
<li>remove</li>
|
||||
<li>restrict</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>typedef</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,208 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for clojure · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for clojure · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for clojure</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>baseNamespace</td><td>the base/top namespace (Default: generated from projectName)</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>projectDescription</td><td>description of the project (Default: using info.description or "Client library of <projectName>")</td><td></td><td>null</td></tr>
|
||||
<tr><td>projectLicenseName</td><td>name of the license the project uses (Default: using info.license.name or not included in project.clj)</td><td></td><td>null</td></tr>
|
||||
<tr><td>projectLicenseUrl</td><td>URL of the license the project uses (Default: using info.license.url or not included in project.clj)</td><td></td><td>null</td></tr>
|
||||
<tr><td>projectName</td><td>name of the project (Default: generated from info.title or "openapi-clj-client")</td><td></td><td>null</td></tr>
|
||||
<tr><td>projectUrl</td><td>URL of the project (Default: using info.contact.url or not included in project.clj)</td><td></td><td>null</td></tr>
|
||||
<tr><td>projectVersion</td><td>version of the project (Default: using info.version or "1.0.0")</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,195 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cpp-pistache-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cpp-pistache-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cpp-pistache-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>addExternalLibs</td><td>Add the Possibility to fetch and compile external Libraries needed by this Framework.</td><td></td><td>true</td></tr>
|
||||
<tr><td>helpersPackage</td><td>Specify the package name to be used for the helpers (e.g. org.openapitools.server.helpers).</td><td></td><td>org.openapitools.server.helpers</td></tr>
|
||||
<tr><td>useStructModel</td><td>Use struct-based model template instead of get/set-based model template</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Object</td><td>#include "Object.h"</td></tr>
|
||||
<tr><td>std::map</td><td>#include <map></td></tr>
|
||||
<tr><td>std::string</td><td>#include <string></td></tr>
|
||||
<tr><td>std::vector</td><td>#include <vector></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>int32_t</li>
|
||||
<li>int64_t</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,286 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cpp-qt5-client · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cpp-qt5-client · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cpp-qt5-client</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>contentCompression</td><td>Enable Compressed Content Encoding for requests and responses</td><td></td><td>false</td></tr>
|
||||
<tr><td>cppNamespace</td><td>C++ namespace (convention: name::space::for::api).</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>modelNamePrefix</td><td>Prefix that will be prepended to all model names.</td><td></td><td>OAI</td></tr>
|
||||
<tr><td>optionalProjectFile</td><td>Generate client.pri.</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>OAIHttpFileElement</td><td>#include "OAIHttpFileElement.h"</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>QByteArray</li>
|
||||
<li>QDate</li>
|
||||
<li>QDateTime</li>
|
||||
<li>QString</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>qint32</li>
|
||||
<li>qint64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>asm</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,285 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cpp-qt5-qhttpengine-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cpp-qt5-qhttpengine-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cpp-qt5-qhttpengine-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>contentCompression</td><td>Enable Compressed Content Encoding for requests and responses</td><td></td><td>false</td></tr>
|
||||
<tr><td>cppNamespace</td><td>C++ namespace (convention: name::space::for::api).</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>modelNamePrefix</td><td>Prefix that will be prepended to all model names.</td><td></td><td>OAI</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>OAIHttpFileElement</td><td>#include "OAIHttpFileElement.h"</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>QByteArray</li>
|
||||
<li>QDate</li>
|
||||
<li>QDateTime</li>
|
||||
<li>QString</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>qint32</li>
|
||||
<li>qint64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>asm</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,285 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cpp-restbed-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cpp-restbed-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cpp-restbed-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>apiPackage</td><td>C++ namespace for apis (convention: name.space.api).</td><td></td><td>org.openapitools.server.api</td></tr>
|
||||
<tr><td>declspec</td><td>C++ preprocessor to place before the class name for handling dllexport/dllimport.</td><td></td><td></td></tr>
|
||||
<tr><td>defaultInclude</td><td>The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"</td><td></td><td></td></tr>
|
||||
<tr><td>modelPackage</td><td>C++ namespace for models (convention: name.space.model).</td><td></td><td>org.openapitools.server.model</td></tr>
|
||||
<tr><td>packageVersion</td><td>C++ package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Object</td><td>#include "Object.h"</td></tr>
|
||||
<tr><td>restbed::Bytes</td><td>#include <corvusoft/restbed/byte.hpp></td></tr>
|
||||
<tr><td>std::map</td><td>#include <map></td></tr>
|
||||
<tr><td>std::string</td><td>#include <string></td></tr>
|
||||
<tr><td>std::vector</td><td>#include <vector></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>int32_t</li>
|
||||
<li>int64_t</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>asm</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,288 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cpp-restsdk · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cpp-restsdk · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cpp-restsdk</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>apiPackage</td><td>C++ namespace for apis (convention: name.space.api).</td><td></td><td>org.openapitools.client.api</td></tr>
|
||||
<tr><td>declspec</td><td>C++ preprocessor to place before the class name for handling dllexport/dllimport.</td><td></td><td></td></tr>
|
||||
<tr><td>defaultInclude</td><td>The default include statement that should be placed in all headers for including things like the declspec (convention: #include "Commons.h"</td><td></td><td></td></tr>
|
||||
<tr><td>generateGMocksForApis</td><td>Generate Google Mock classes for APIs.</td><td></td><td>null</td></tr>
|
||||
<tr><td>modelPackage</td><td>C++ namespace for models (convention: name.space.model).</td><td></td><td>org.openapitools.client.model</td></tr>
|
||||
<tr><td>packageVersion</td><td>C++ package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>HttpContent</td><td>#include "HttpContent.h"</td></tr>
|
||||
<tr><td>Object</td><td>#include "Object.h"</td></tr>
|
||||
<tr><td>std::map</td><td>#include <map></td></tr>
|
||||
<tr><td>std::string</td><td>#include <string></td></tr>
|
||||
<tr><td>std::vector</td><td>#include <vector></td></tr>
|
||||
<tr><td>utility::datetime</td><td>#include <cpprest/details/basic_types.h></td></tr>
|
||||
<tr><td>utility::string_t</td><td>#include <cpprest/details/basic_types.h></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>char</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>int32_t</li>
|
||||
<li>int64_t</li>
|
||||
<li>long</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>asm</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>linux</li>
|
||||
<li>long</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,283 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cpp-tizen · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cpp-tizen · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cpp-tizen</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>int</li>
|
||||
<li>long long</li>
|
||||
<li>std::string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>alignas</li>
|
||||
<li>alignof</li>
|
||||
<li>and</li>
|
||||
<li>and_eq</li>
|
||||
<li>asm</li>
|
||||
<li>atomic_cancel</li>
|
||||
<li>atomic_commit</li>
|
||||
<li>atomic_noexcept</li>
|
||||
<li>auto</li>
|
||||
<li>bitand</li>
|
||||
<li>bitor</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>char16_t</li>
|
||||
<li>char32_t</li>
|
||||
<li>class</li>
|
||||
<li>compl</li>
|
||||
<li>concept</li>
|
||||
<li>const</li>
|
||||
<li>const_cast</li>
|
||||
<li>constexpr</li>
|
||||
<li>continue</li>
|
||||
<li>decltype</li>
|
||||
<li>default</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>dynamic_cast</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>explicit</li>
|
||||
<li>export</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>friend</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>long</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>noexcept</li>
|
||||
<li>not</li>
|
||||
<li>not_eq</li>
|
||||
<li>nullptr</li>
|
||||
<li>operator</li>
|
||||
<li>or</li>
|
||||
<li>or_eq</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>register</li>
|
||||
<li>reinterpret_cast</li>
|
||||
<li>requires</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>signed</li>
|
||||
<li>sizeof</li>
|
||||
<li>static</li>
|
||||
<li>static_assert</li>
|
||||
<li>static_cast</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>template</li>
|
||||
<li>this</li>
|
||||
<li>thread_local</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>typeid</li>
|
||||
<li>typename</li>
|
||||
<li>union</li>
|
||||
<li>unsigned</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>wchar_t</li>
|
||||
<li>while</li>
|
||||
<li>xor</li>
|
||||
<li>xor_eq</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,311 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for csharp-dotnet2 · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for csharp-dotnet2 · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for csharp-dotnet2</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>clientPackage</td><td>C# client package name (convention: Camel.Case).</td><td></td><td>Org.OpenAPITools.Client</td></tr>
|
||||
<tr><td>packageName</td><td>C# package name (convention: Camel.Case).</td><td></td><td>Org.OpenAPITools</td></tr>
|
||||
<tr><td>packageVersion</td><td>C# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>list</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Dictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,237 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for csharp-nancyfx · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for csharp-nancyfx · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for csharp-nancyfx</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>asyncServer</td><td>Set to true to enable the generation of async routes/endpoints.</td><td></td><td>false</td></tr>
|
||||
<tr><td>immutable</td><td>Enabled by default. If disabled generates model classes with setters</td><td></td><td>true</td></tr>
|
||||
<tr><td>interfacePrefix</td><td>Prefix interfaces with a community standard or widely accepted prefix.</td><td></td><td></td></tr>
|
||||
<tr><td>optionalProjectFile</td><td>Generate {PackageName}.csproj.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageContext</td><td>Optionally overrides the PackageContext which determines the namespace (namespace=packageName.packageContext). If not set, packageContext will default to basePath.</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>C# package name (convention: Title.Case).</td><td></td><td>Org.OpenAPITools</td></tr>
|
||||
<tr><td>packageVersion</td><td>C# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>returnICollection</td><td>Return ICollection<T> instead of the concrete type.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
|
||||
<tr><td>useCollection</td><td>Deserialize array types to Collection<T> instead of List<T>.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useDateTimeOffset</td><td>Use DateTimeOffset to model date-time properties</td><td></td><td>false</td></tr>
|
||||
<tr><td>writeModulePath</td><td>Enabled by default. If disabled, module paths will not mirror api base path</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>list</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Dictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>LocalDate?</li>
|
||||
<li>LocalTime?</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>ZonedDateTime?</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>async</li>
|
||||
<li>await</li>
|
||||
<li>dynamic</li>
|
||||
<li>var</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,332 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for csharp-netcore · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for csharp-netcore · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for csharp-netcore</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>caseInsensitiveResponseHeaders</td><td>Make API response's headers case-insensitive</td><td></td><td>false</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>interfacePrefix</td><td>Prefix interfaces with a community standard or widely accepted prefix.</td><td></td><td>I</td></tr>
|
||||
<tr><td>licenseId</td><td>The identifier of the license</td><td></td><td>null</td></tr>
|
||||
<tr><td>modelPropertyNaming</td><td>Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name</td><td></td><td>PascalCase</td></tr>
|
||||
<tr><td>netCoreProjectFile</td><td>Use the new format (.NET Core) for .NET project files (.csproj).</td><td></td><td>false</td></tr>
|
||||
<tr><td>nonPublicApi</td><td>Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.</td><td></td><td>false</td></tr>
|
||||
<tr><td>optionalAssemblyInfo</td><td>Generate AssemblyInfo.cs.</td><td></td><td>true</td></tr>
|
||||
<tr><td>optionalEmitDefaultValues</td><td>Set DataMember's EmitDefaultValue.</td><td></td><td>false</td></tr>
|
||||
<tr><td>optionalMethodArgument</td><td>C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).</td><td></td><td>true</td></tr>
|
||||
<tr><td>optionalProjectFile</td><td>Generate {PackageName}.csproj.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>C# package name (convention: Title.Case).</td><td></td><td>Org.OpenAPITools</td></tr>
|
||||
<tr><td>packageTags</td><td>Tags to identify the package</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageVersion</td><td>C# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>releaseNote</td><td>Release note, default to 'Minor update'.</td><td></td><td>Minor update</td></tr>
|
||||
<tr><td>returnICollection</td><td>Return ICollection<T> instead of the concrete type.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
|
||||
<tr><td>targetFramework</td><td>The target .NET framework version.</td><td><dl><dt><strong>netstandard1.3</strong></dt><dd>.NET Standard 1.3 compatible</dd><dt><strong>netstandard1.4</strong></dt><dd>.NET Standard 1.4 compatible</dd><dt><strong>netstandard1.5</strong></dt><dd>.NET Standard 1.5 compatible</dd><dt><strong>netstandard1.6</strong></dt><dd>.NET Standard 1.6 compatible</dd><dt><strong>netstandard2.0</strong></dt><dd>.NET Standard 2.0 compatible</dd><dt><strong>netstandard2.1</strong></dt><dd>.NET Standard 2.1 compatible</dd><dt><strong>netcoreapp2.0</strong></dt><dd>.NET Core 2.0 compatible</dd><dt><strong>netcoreapp2.1</strong></dt><dd>.NET Core 2.1 compatible</dd><dt><strong>netcoreapp3.0</strong></dt><dd>.NET Core 3.0 compatible</dd><dt><strong>netcoreapp3.1</strong></dt><dd>.NET Core 3.1 compatible</dd><dl></td><td>netstandard2.0</td></tr>
|
||||
<tr><td>useCollection</td><td>Deserialize array types to Collection<T> instead of List<T>.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useDateTimeOffset</td><td>Use DateTimeOffset to model date-time properties</td><td></td><td>false</td></tr>
|
||||
<tr><td>validatable</td><td>Generates self-validatable models.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>list</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Dictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,331 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for csharp · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for csharp · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for csharp</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>caseInsensitiveResponseHeaders</td><td>Make API response's headers case-insensitive</td><td></td><td>false</td></tr>
|
||||
<tr><td>generatePropertyChanged</td><td>Specifies a AssemblyDescription for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>false</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>interfacePrefix</td><td>Prefix interfaces with a community standard or widely accepted prefix.</td><td></td><td>I</td></tr>
|
||||
<tr><td>modelPropertyNaming</td><td>Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name</td><td></td><td>PascalCase</td></tr>
|
||||
<tr><td>netCoreProjectFile</td><td>Use the new format (.NET Core) for .NET project files (.csproj).</td><td></td><td>false</td></tr>
|
||||
<tr><td>nonPublicApi</td><td>Generates code with reduced access modifiers; allows embedding elsewhere without exposing non-public API calls to consumers.</td><td></td><td>false</td></tr>
|
||||
<tr><td>optionalAssemblyInfo</td><td>Generate AssemblyInfo.cs.</td><td></td><td>true</td></tr>
|
||||
<tr><td>optionalEmitDefaultValues</td><td>Set DataMember's EmitDefaultValue.</td><td></td><td>false</td></tr>
|
||||
<tr><td>optionalMethodArgument</td><td>C# Optional method argument, e.g. void square(int x=10) (.net 4.0+ only).</td><td></td><td>true</td></tr>
|
||||
<tr><td>optionalProjectFile</td><td>Generate {PackageName}.csproj.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>C# package name (convention: Title.Case).</td><td></td><td>Org.OpenAPITools</td></tr>
|
||||
<tr><td>packageVersion</td><td>C# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>returnICollection</td><td>Return ICollection<T> instead of the concrete type.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src</td></tr>
|
||||
<tr><td>targetFramework</td><td>The target .NET framework version.</td><td><dl><dt><strong>v3.5</strong></dt><dd>.NET Framework 3.5 compatible</dd><dt><strong>v4.0</strong></dt><dd>.NET Framework 4.0 compatible</dd><dt><strong>v4.5</strong></dt><dd>.NET Framework 4.5+ compatible</dd><dt><strong>v5.0</strong></dt><dd>.NET Standard 1.3 compatible (DEPRECATED. Please use <code>csharp-netcore</code> generator instead)</dd><dt><strong>uwp</strong></dt><dd>Universal Windows Platform (DEPRECATED. Please use <code>csharp-netcore</code> generator instead)</dd><dl></td><td>v4.5</td></tr>
|
||||
<tr><td>useCollection</td><td>Deserialize array types to Collection<T> instead of List<T>.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useCompareNetObjects</td><td>Use KellermanSoftware.CompareNetObjects for deep recursive object comparison. WARNING: this option incurs potential performance impact.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useDateTimeOffset</td><td>Use DateTimeOffset to model date-time properties</td><td></td><td>false</td></tr>
|
||||
<tr><td>validatable</td><td>Generates self-validatable models.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>list</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Dictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Collection</li>
|
||||
<li>DateTime</li>
|
||||
<li>DateTime?</li>
|
||||
<li>DateTimeOffset</li>
|
||||
<li>DateTimeOffset?</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Guid</li>
|
||||
<li>Guid?</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>bool?</li>
|
||||
<li>byte[]</li>
|
||||
<li>decimal</li>
|
||||
<li>decimal?</li>
|
||||
<li>double</li>
|
||||
<li>double?</li>
|
||||
<li>float</li>
|
||||
<li>float?</li>
|
||||
<li>int</li>
|
||||
<li>int?</li>
|
||||
<li>long</li>
|
||||
<li>long?</li>
|
||||
<li>string</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Client</li>
|
||||
<li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>base</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>client</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implicit</li>
|
||||
<li>in</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>long</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>override</li>
|
||||
<li>parameter</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>readonly</li>
|
||||
<li>ref</li>
|
||||
<li>return</li>
|
||||
<li>sbyte</li>
|
||||
<li>sealed</li>
|
||||
<li>short</li>
|
||||
<li>sizeof</li>
|
||||
<li>stackalloc</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typeof</li>
|
||||
<li>uint</li>
|
||||
<li>ulong</li>
|
||||
<li>unchecked</li>
|
||||
<li>unsafe</li>
|
||||
<li>ushort</li>
|
||||
<li>using</li>
|
||||
<li>virtual</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,195 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for cwiki · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for cwiki · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for cwiki</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>appDescription</td><td>description of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>appName</td><td>short name of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoEmail</td><td>an email address to contact for inquiries about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoUrl</td><td>a URL where users can get more information about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseInfo</td><td>a short description of the license</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseUrl</td><td>a URL pointing to the full license</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,277 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for dart-dio · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for dart-dio · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for dart-dio</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>browserClient</td><td>Is the client browser based (for Dart 1.x only)</td><td></td><td>null</td></tr>
|
||||
<tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>core</strong></dt><dd>Dart core library (DateTime)</dd><dt><strong>timemachine</strong></dt><dd>Time Machine is date and time library for Flutter, Web, and Server with support for timezones, calendars, cultures, formatting and parsing.</dd><dl></td><td>core</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>nullableFields</td><td>Is the null fields should be in the JSON payload</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>pubAuthor</td><td>Author name in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubAuthorEmail</td><td>Email address of the author in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubDescription</td><td>Description in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubHomepage</td><td>Homepage in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubName</td><td>Name in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubVersion</td><td>Version in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>Source folder for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>supportDart2</td><td>Support Dart 2.x (Dart 1.x support has been deprecated)</td><td></td><td>true</td></tr>
|
||||
<tr><td>useEnumExtension</td><td>Allow the 'x-enum-values' extension for enums</td><td></td><td>null</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BuiltList</td><td>package:built_collection/built_collection.dart</td></tr>
|
||||
<tr><td>BuiltMap</td><td>package:built_collection/built_collection.dart</td></tr>
|
||||
<tr><td>JsonObject</td><td>package:built_value/json_object.dart</td></tr>
|
||||
<tr><td>Uint8List</td><td>dart:typed_data</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Map</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>String</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>int</li>
|
||||
<li>num</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>covariant</li>
|
||||
<li>default</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>extension</li>
|
||||
<li>external</li>
|
||||
<li>factory</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>get</li>
|
||||
<li>hide</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inout</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>late</li>
|
||||
<li>library</li>
|
||||
<li>mixin</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>part</li>
|
||||
<li>patch</li>
|
||||
<li>required</li>
|
||||
<li>rethrow</li>
|
||||
<li>return</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>source</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>sync</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,273 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for dart-jaguar · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for dart-jaguar · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for dart-jaguar</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>browserClient</td><td>Is the client browser based (for Dart 1.x only)</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>nullableFields</td><td>Is the null fields should be in the JSON payload</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>pubAuthor</td><td>Author name in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubAuthorEmail</td><td>Email address of the author in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubDescription</td><td>Description in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubHomepage</td><td>Homepage in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubName</td><td>Name in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubVersion</td><td>Version in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>serialization</td><td>Choose serialization format JSON or PROTO is supported</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>Source folder for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>supportDart2</td><td>Support Dart 2.x (Dart 1.x support has been deprecated)</td><td></td><td>true</td></tr>
|
||||
<tr><td>useEnumExtension</td><td>Allow the 'x-enum-values' extension for enums</td><td></td><td>null</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Map</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>String</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>int</li>
|
||||
<li>num</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>covariant</li>
|
||||
<li>default</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>extension</li>
|
||||
<li>external</li>
|
||||
<li>factory</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>get</li>
|
||||
<li>hide</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inout</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>late</li>
|
||||
<li>library</li>
|
||||
<li>mixin</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>part</li>
|
||||
<li>patch</li>
|
||||
<li>required</li>
|
||||
<li>rethrow</li>
|
||||
<li>return</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>source</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>sync</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,271 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for dart · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for dart · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for dart</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>browserClient</td><td>Is the client browser based (for Dart 1.x only)</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>pubAuthor</td><td>Author name in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubAuthorEmail</td><td>Email address of the author in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubDescription</td><td>Description in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubHomepage</td><td>Homepage in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubName</td><td>Name in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>pubVersion</td><td>Version in generated pubspec</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>Source folder for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>supportDart2</td><td>Support Dart 2.x (Dart 1.x support has been deprecated)</td><td></td><td>true</td></tr>
|
||||
<tr><td>useEnumExtension</td><td>Allow the 'x-enum-values' extension for enums</td><td></td><td>null</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Map</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>String</li>
|
||||
<li>bool</li>
|
||||
<li>double</li>
|
||||
<li>int</li>
|
||||
<li>num</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>break</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>covariant</li>
|
||||
<li>default</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>dynamic</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>export</li>
|
||||
<li>extends</li>
|
||||
<li>extension</li>
|
||||
<li>external</li>
|
||||
<li>factory</li>
|
||||
<li>false</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>get</li>
|
||||
<li>hide</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>inout</li>
|
||||
<li>interface</li>
|
||||
<li>is</li>
|
||||
<li>late</li>
|
||||
<li>library</li>
|
||||
<li>mixin</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>on</li>
|
||||
<li>operator</li>
|
||||
<li>out</li>
|
||||
<li>part</li>
|
||||
<li>patch</li>
|
||||
<li>required</li>
|
||||
<li>rethrow</li>
|
||||
<li>return</li>
|
||||
<li>set</li>
|
||||
<li>show</li>
|
||||
<li>source</li>
|
||||
<li>static</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>sync</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>typedef</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,191 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for dynamic-html · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for dynamic-html · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for dynamic-html</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ArrayList</td></tr>
|
||||
<tr><td>map</td><td>HashMap</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,273 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for eiffel · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for eiffel · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for eiffel</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageName</td><td>Eiffel Cluster name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Eiffel package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ARRAYED_LIST</td></tr>
|
||||
<tr><td>list</td><td>ARRAYED_LIST</td></tr>
|
||||
<tr><td>map</td><td>STRING_TABLE</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>BOOLEAN</li>
|
||||
<li>INTEGER_16</li>
|
||||
<li>INTEGER_32</li>
|
||||
<li>INTEGER_64</li>
|
||||
<li>INTEGER_8</li>
|
||||
<li>NATURAL_16</li>
|
||||
<li>NATURAL_32</li>
|
||||
<li>NATURAL_64</li>
|
||||
<li>NATURAL_8</li>
|
||||
<li>REAL_32</li>
|
||||
<li>REAL_64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>across</li>
|
||||
<li>agent</li>
|
||||
<li>alias</li>
|
||||
<li>all</li>
|
||||
<li>and</li>
|
||||
<li>as</li>
|
||||
<li>assign</li>
|
||||
<li>attribute</li>
|
||||
<li>check</li>
|
||||
<li>class</li>
|
||||
<li>convert</li>
|
||||
<li>create</li>
|
||||
<li>current</li>
|
||||
<li>debug</li>
|
||||
<li>deferred</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>elseif</li>
|
||||
<li>end</li>
|
||||
<li>ensure</li>
|
||||
<li>expanded</li>
|
||||
<li>export</li>
|
||||
<li>external</li>
|
||||
<li>false</li>
|
||||
<li>feature</li>
|
||||
<li>from</li>
|
||||
<li>frozen</li>
|
||||
<li>if</li>
|
||||
<li>implies</li>
|
||||
<li>inherit</li>
|
||||
<li>inspect</li>
|
||||
<li>invariant</li>
|
||||
<li>like</li>
|
||||
<li>local</li>
|
||||
<li>loop</li>
|
||||
<li>not</li>
|
||||
<li>note</li>
|
||||
<li>obsolete</li>
|
||||
<li>old</li>
|
||||
<li>once</li>
|
||||
<li>only</li>
|
||||
<li>or</li>
|
||||
<li>precursor</li>
|
||||
<li>redefine</li>
|
||||
<li>rename</li>
|
||||
<li>require</li>
|
||||
<li>rescue</li>
|
||||
<li>result</li>
|
||||
<li>retry</li>
|
||||
<li>select</li>
|
||||
<li>separate</li>
|
||||
<li>then</li>
|
||||
<li>true</li>
|
||||
<li>tuple</li>
|
||||
<li>undefine</li>
|
||||
<li>until</li>
|
||||
<li>variant</li>
|
||||
<li>void</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,222 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for elixir · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for elixir · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for elixir</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>invokerPackage</td><td>The main namespace to use for all classes. e.g. Yay.Pets</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseHeader</td><td>The license header to prepend to the top of all source files.</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>Elixir package name (convention: lowercase).</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Atom</li>
|
||||
<li>Boolean</li>
|
||||
<li>DateTime</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>List</li>
|
||||
<li>Map</li>
|
||||
<li>PID</li>
|
||||
<li>String</li>
|
||||
<li>Tuple</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>__CALLER__</li>
|
||||
<li>__DIR__</li>
|
||||
<li>__ENV__</li>
|
||||
<li>__FILE__</li>
|
||||
<li>__MODULE__</li>
|
||||
<li>false</li>
|
||||
<li>nil</li>
|
||||
<li>true</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,206 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for elm · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for elm · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for elm</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>elmEnableCustomBasePaths</td><td>Enable setting the base path for each request</td><td></td><td>false</td></tr>
|
||||
<tr><td>elmEnableHttpRequestTrackers</td><td>Enable adding a tracker to each http request</td><td></td><td>false</td></tr>
|
||||
<tr><td>elmPrefixCustomTypeVariants</td><td>Prefix custom type variants</td><td></td><td>false</td></tr>
|
||||
<tr><td>elmVersion</td><td>Elm version: 0.18, 0.19</td><td><dl><dt><strong>0.19</strong></dt><dd>Elm 0.19</dd><dt><strong>0.18</strong></dt><dd>Elm 0.18</dd><dl></td><td>0.19</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>List</td></tr>
|
||||
<tr><td>map</td><td>Dict</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Bool</li>
|
||||
<li>Dict</li>
|
||||
<li>Float</li>
|
||||
<li>Int</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>as</li>
|
||||
<li>case</li>
|
||||
<li>else</li>
|
||||
<li>exposing</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>let</li>
|
||||
<li>module</li>
|
||||
<li>of</li>
|
||||
<li>port</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>where</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,225 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for erlang-client · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for erlang-client · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for erlang-client</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>packageName</td><td>Erlang application name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Erlang application version</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>after</li>
|
||||
<li>and</li>
|
||||
<li>andalso</li>
|
||||
<li>band</li>
|
||||
<li>begin</li>
|
||||
<li>bnot</li>
|
||||
<li>bor</li>
|
||||
<li>bsl</li>
|
||||
<li>bsr</li>
|
||||
<li>bxor</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>cond</li>
|
||||
<li>div</li>
|
||||
<li>end</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>let</li>
|
||||
<li>not</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>orelse</li>
|
||||
<li>receive</li>
|
||||
<li>rem</li>
|
||||
<li>try</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,225 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for erlang-proper · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for erlang-proper · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for erlang-proper</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>packageName</td><td>Erlang application name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Erlang application version</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>after</li>
|
||||
<li>and</li>
|
||||
<li>andalso</li>
|
||||
<li>band</li>
|
||||
<li>begin</li>
|
||||
<li>bnot</li>
|
||||
<li>bor</li>
|
||||
<li>bsl</li>
|
||||
<li>bsr</li>
|
||||
<li>bxor</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>cond</li>
|
||||
<li>div</li>
|
||||
<li>end</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>let</li>
|
||||
<li>not</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>orelse</li>
|
||||
<li>receive</li>
|
||||
<li>rem</li>
|
||||
<li>try</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,225 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for erlang-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for erlang-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for erlang-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>openAPISpecName</td><td>Openapi Spec Name.</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageName</td><td>Erlang package name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>after</li>
|
||||
<li>and</li>
|
||||
<li>andalso</li>
|
||||
<li>band</li>
|
||||
<li>begin</li>
|
||||
<li>bnot</li>
|
||||
<li>bor</li>
|
||||
<li>bsl</li>
|
||||
<li>bsr</li>
|
||||
<li>bxor</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>cond</li>
|
||||
<li>div</li>
|
||||
<li>end</li>
|
||||
<li>fun</li>
|
||||
<li>if</li>
|
||||
<li>let</li>
|
||||
<li>not</li>
|
||||
<li>of</li>
|
||||
<li>or</li>
|
||||
<li>orelse</li>
|
||||
<li>receive</li>
|
||||
<li>rem</li>
|
||||
<li>try</li>
|
||||
<li>when</li>
|
||||
<li>xor</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,222 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for flash · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for flash · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for flash</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>flash package name (convention: package.name)</td><td></td><td>org.openapitools</td></tr>
|
||||
<tr><td>packageVersion</td><td>flash package version</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code. e.g. flash</td><td></td><td>null</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>File</td><td>flash.filesystem.File</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Array</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Number</li>
|
||||
<li>String</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>add</li>
|
||||
<li>and</li>
|
||||
<li>break</li>
|
||||
<li>continue</li>
|
||||
<li>delete</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>eq</li>
|
||||
<li>for</li>
|
||||
<li>function</li>
|
||||
<li>ge</li>
|
||||
<li>gt</li>
|
||||
<li>if</li>
|
||||
<li>ifframeloaded</li>
|
||||
<li>in</li>
|
||||
<li>le</li>
|
||||
<li>lt</li>
|
||||
<li>ne</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>on</li>
|
||||
<li>onclipevent</li>
|
||||
<li>or</li>
|
||||
<li>return</li>
|
||||
<li>telltarget</li>
|
||||
<li>this</li>
|
||||
<li>typeof</li>
|
||||
<li>var</li>
|
||||
<li>void</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,340 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for fsharp-functions · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for fsharp-functions · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for fsharp-functions</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>NoLicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://localhost">http://localhost</a></td></tr>
|
||||
<tr><td>packageAuthors</td><td>Specifies Authors property in the .NET Core project file.</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>packageCopyright</td><td>Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>No Copyright</td></tr>
|
||||
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>F# module name (convention: Title.Case).</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>packageTitle</td><td>Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>OpenAPI Library</td></tr>
|
||||
<tr><td>packageVersion</td><td>F# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>OpenAPI/src</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>IDictionary</td><td>System.Collections.Generic</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>list</td></tr>
|
||||
<tr><td>list</td><td>list</td></tr>
|
||||
<tr><td>map</td><td>IDictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Collection</li>
|
||||
<li>DataTimeOffset</li>
|
||||
<li>DateTime</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>byte[]</li>
|
||||
<li>char</li>
|
||||
<li>decimal</li>
|
||||
<li>dict</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>float32</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int64</li>
|
||||
<li>list</li>
|
||||
<li>nativeint</li>
|
||||
<li>obj</li>
|
||||
<li>seq</li>
|
||||
<li>single</li>
|
||||
<li>string</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>unativeint</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>base</li>
|
||||
<li>begin</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>done</li>
|
||||
<li>double</li>
|
||||
<li>downcast</li>
|
||||
<li>downto</li>
|
||||
<li>dynamic</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>exception</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>fun</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>inherit</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>lazy</li>
|
||||
<li>let</li>
|
||||
<li>let!</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>match</li>
|
||||
<li>match!</li>
|
||||
<li>member</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>open</li>
|
||||
<li>option</li>
|
||||
<li>or</li>
|
||||
<li>override</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>public</li>
|
||||
<li>raise</li>
|
||||
<li>rec</li>
|
||||
<li>return</li>
|
||||
<li>return!</li>
|
||||
<li>sealed</li>
|
||||
<li>select</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>then</li>
|
||||
<li>to</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>type</li>
|
||||
<li>upcast</li>
|
||||
<li>use</li>
|
||||
<li>use!</li>
|
||||
<li>val</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
<li>yield!</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,342 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for fsharp-giraffe-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for fsharp-giraffe-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for fsharp-giraffe-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>buildTarget</td><td>Target the build for a program or library.</td><td></td><td>program</td></tr>
|
||||
<tr><td>generateBody</td><td>Generates method body.</td><td></td><td>true</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>NoLicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://localhost">http://localhost</a></td></tr>
|
||||
<tr><td>packageAuthors</td><td>Specifies Authors property in the .NET Core project file.</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>packageCopyright</td><td>Specifies an AssemblyCopyright for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>No Copyright</td></tr>
|
||||
<tr><td>packageGuid</td><td>The GUID that will be associated with the C# project</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>F# module name (convention: Title.Case).</td><td></td><td>OpenAPI</td></tr>
|
||||
<tr><td>packageTitle</td><td>Specifies an AssemblyTitle for the .NET Framework global assembly attributes stored in the AssemblyInfo file.</td><td></td><td>OpenAPI Library</td></tr>
|
||||
<tr><td>packageVersion</td><td>F# package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>returnICollection</td><td>Return ICollection<T> instead of the concrete type.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>OpenAPI/src</td></tr>
|
||||
<tr><td>useCollection</td><td>Deserialize array types to Collection<T> instead of List<T>.</td><td></td><td>false</td></tr>
|
||||
<tr><td>useDateTimeOffset</td><td>Use DateTimeOffset to model date-time properties</td><td></td><td>false</td></tr>
|
||||
<tr><td>useSwashbuckle</td><td>Uses the Swashbuckle.AspNetCore NuGet package for documentation.</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>IDictionary</td><td>System.Collections.Generic</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>list</td></tr>
|
||||
<tr><td>list</td><td>list</td></tr>
|
||||
<tr><td>map</td><td>IDictionary</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Collection</li>
|
||||
<li>DataTimeOffset</li>
|
||||
<li>DateTime</li>
|
||||
<li>Dictionary</li>
|
||||
<li>Double</li>
|
||||
<li>ICollection</li>
|
||||
<li>Int32</li>
|
||||
<li>Int64</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>System.IO.Stream</li>
|
||||
<li>bool</li>
|
||||
<li>byte[]</li>
|
||||
<li>char</li>
|
||||
<li>decimal</li>
|
||||
<li>dict</li>
|
||||
<li>double</li>
|
||||
<li>float</li>
|
||||
<li>float32</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int64</li>
|
||||
<li>list</li>
|
||||
<li>nativeint</li>
|
||||
<li>obj</li>
|
||||
<li>seq</li>
|
||||
<li>single</li>
|
||||
<li>string</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>unativeint</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>and</li>
|
||||
<li>as</li>
|
||||
<li>assert</li>
|
||||
<li>async</li>
|
||||
<li>await</li>
|
||||
<li>base</li>
|
||||
<li>begin</li>
|
||||
<li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>checked</li>
|
||||
<li>class</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>decimal</li>
|
||||
<li>default</li>
|
||||
<li>delegate</li>
|
||||
<li>do</li>
|
||||
<li>done</li>
|
||||
<li>double</li>
|
||||
<li>downcast</li>
|
||||
<li>downto</li>
|
||||
<li>dynamic</li>
|
||||
<li>elif</li>
|
||||
<li>else</li>
|
||||
<li>end</li>
|
||||
<li>enum</li>
|
||||
<li>event</li>
|
||||
<li>exception</li>
|
||||
<li>explicit</li>
|
||||
<li>extern</li>
|
||||
<li>false</li>
|
||||
<li>finally</li>
|
||||
<li>fixed</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>foreach</li>
|
||||
<li>fun</li>
|
||||
<li>function</li>
|
||||
<li>if</li>
|
||||
<li>in</li>
|
||||
<li>inherit</li>
|
||||
<li>inline</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>internal</li>
|
||||
<li>is</li>
|
||||
<li>lazy</li>
|
||||
<li>let</li>
|
||||
<li>let!</li>
|
||||
<li>localVarFileParams</li>
|
||||
<li>localVarFormParams</li>
|
||||
<li>localVarHeaderParams</li>
|
||||
<li>localVarHttpContentType</li>
|
||||
<li>localVarHttpContentTypes</li>
|
||||
<li>localVarHttpHeaderAccept</li>
|
||||
<li>localVarHttpHeaderAccepts</li>
|
||||
<li>localVarPath</li>
|
||||
<li>localVarPathParams</li>
|
||||
<li>localVarPostBody</li>
|
||||
<li>localVarQueryParams</li>
|
||||
<li>localVarResponse</li>
|
||||
<li>localVarStatusCode</li>
|
||||
<li>lock</li>
|
||||
<li>match</li>
|
||||
<li>match!</li>
|
||||
<li>member</li>
|
||||
<li>module</li>
|
||||
<li>mutable</li>
|
||||
<li>namespace</li>
|
||||
<li>new</li>
|
||||
<li>not</li>
|
||||
<li>null</li>
|
||||
<li>of</li>
|
||||
<li>open</li>
|
||||
<li>option</li>
|
||||
<li>or</li>
|
||||
<li>override</li>
|
||||
<li>params</li>
|
||||
<li>private</li>
|
||||
<li>public</li>
|
||||
<li>raise</li>
|
||||
<li>rec</li>
|
||||
<li>return</li>
|
||||
<li>return!</li>
|
||||
<li>sealed</li>
|
||||
<li>select</li>
|
||||
<li>static</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>then</li>
|
||||
<li>to</li>
|
||||
<li>true</li>
|
||||
<li>try</li>
|
||||
<li>type</li>
|
||||
<li>upcast</li>
|
||||
<li>use</li>
|
||||
<li>use!</li>
|
||||
<li>val</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>when</li>
|
||||
<li>while</li>
|
||||
<li>with</li>
|
||||
<li>yield</li>
|
||||
<li>yield!</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,250 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for go-experimental · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for go-experimental · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for go-experimental</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>enumClassPrefix</td><td>Prefix enum with class name</td><td></td><td>false</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>isGoSubmodule</td><td>whether the generated Go module is a submodule</td><td></td><td>false</td></tr>
|
||||
<tr><td>packageName</td><td>Go package name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Go package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>structPrefix</td><td>whether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOpts</td><td></td><td>false</td></tr>
|
||||
<tr><td>withAWSV4Signature</td><td>whether to include AWS v4 signature support</td><td></td><td>false</td></tr>
|
||||
<tr><td>withGoCodegenComment</td><td>whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs</td><td></td><td>false</td></tr>
|
||||
<tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>int</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>uintptr</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,243 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for go-gin-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for go-gin-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for go-gin-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageName</td><td>Go package name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Go package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>int</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>uintptr</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,246 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for go-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for go-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for go-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>featureCORS</td><td>Enable Cross-Origin Resource Sharing middleware</td><td></td><td>false</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageName</td><td>Go package name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Go package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>serverPort</td><td>The network port the generated server binds to</td><td></td><td>8080</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>go</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>int</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>uintptr</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,250 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for go · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for go · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for go</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>enumClassPrefix</td><td>Prefix enum with class name</td><td></td><td>false</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>isGoSubmodule</td><td>whether the generated Go module is a submodule</td><td></td><td>false</td></tr>
|
||||
<tr><td>packageName</td><td>Go package name (convention: lowercase).</td><td></td><td>openapi</td></tr>
|
||||
<tr><td>packageVersion</td><td>Go package version.</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>structPrefix</td><td>whether to prefix struct with the class name. e.g. DeletePetOpts => PetApiDeletePetOpts</td><td></td><td>false</td></tr>
|
||||
<tr><td>withAWSV4Signature</td><td>whether to include AWS v4 signature support</td><td></td><td>false</td></tr>
|
||||
<tr><td>withGoCodegenComment</td><td>whether to include Go codegen comment to disable Go Lint and collapse by default GitHub in PRs and diffs</td><td></td><td>false</td></tr>
|
||||
<tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>byte</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>int</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>rune</li>
|
||||
<li>string</li>
|
||||
<li>uint</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>bool</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>chan</li>
|
||||
<li>complex128</li>
|
||||
<li>complex64</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>defer</li>
|
||||
<li>else</li>
|
||||
<li>error</li>
|
||||
<li>fallthrough</li>
|
||||
<li>float32</li>
|
||||
<li>float64</li>
|
||||
<li>for</li>
|
||||
<li>func</li>
|
||||
<li>go</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>int</li>
|
||||
<li>int16</li>
|
||||
<li>int32</li>
|
||||
<li>int64</li>
|
||||
<li>int8</li>
|
||||
<li>interface</li>
|
||||
<li>map</li>
|
||||
<li>nil</li>
|
||||
<li>package</li>
|
||||
<li>range</li>
|
||||
<li>return</li>
|
||||
<li>rune</li>
|
||||
<li>select</li>
|
||||
<li>string</li>
|
||||
<li>struct</li>
|
||||
<li>switch</li>
|
||||
<li>type</li>
|
||||
<li>uint</li>
|
||||
<li>uint16</li>
|
||||
<li>uint32</li>
|
||||
<li>uint64</li>
|
||||
<li>uint8</li>
|
||||
<li>uintptr</li>
|
||||
<li>var</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,216 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for graphql-nodejs-express-server · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for graphql-nodejs-express-server · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for graphql-nodejs-express-server</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageName</td><td>GraphQL Node.js Express server package name (convention: lowercase).</td><td></td><td>openapi3graphql-server</td></tr>
|
||||
<tr><td>packageVersion</td><td>GraphQL Node.js Express server package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Float</li>
|
||||
<li>ID</li>
|
||||
<li>Int</li>
|
||||
<li>String</li>
|
||||
<li>null</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>boolean</li>
|
||||
<li>float</li>
|
||||
<li>id</li>
|
||||
<li>implements</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>null</li>
|
||||
<li>query</li>
|
||||
<li>string</li>
|
||||
<li>type</li>
|
||||
<li>union</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,216 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for graphql-schema · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for graphql-schema · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for graphql-schema</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>packageName</td><td>GraphQL package name (convention: lowercase).</td><td></td><td>openapi2graphql</td></tr>
|
||||
<tr><td>packageVersion</td><td>GraphQL package version.</td><td></td><td>1.0.0</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Float</li>
|
||||
<li>ID</li>
|
||||
<li>Int</li>
|
||||
<li>String</li>
|
||||
<li>null</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>boolean</li>
|
||||
<li>float</li>
|
||||
<li>id</li>
|
||||
<li>implements</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>null</li>
|
||||
<li>query</li>
|
||||
<li>string</li>
|
||||
<li>type</li>
|
||||
<li>union</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,316 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for groovy · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for groovy · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for groovy</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>additionalModelTypeAnnotations</td><td>Additional annotations for model type(class level annotations)</td><td></td><td>null</td></tr>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>org.openapitools.api</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>openapi-groovy</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>bigDecimalAsString</td><td>Treat BigDecimal values as Strings to avoid precision loss.</td><td></td><td>false</td></tr>
|
||||
<tr><td>booleanGetterPrefix</td><td>Set booleanGetterPrefix</td><td></td><td>get</td></tr>
|
||||
<tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>joda</strong></dt><dd>Joda (for legacy app only)</dd><dt><strong>legacy</strong></dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt><strong>java8-localdatetime</strong></dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt><strong>java8</strong></dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt><strong>threetenbp</strong></dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl></td><td>legacy</td></tr>
|
||||
<tr><td>developerEmail</td><td>developer email in generated pom.xml</td><td></td><td><a href="mailto:team@openapitools.org">team@openapitools.org</a></td></tr>
|
||||
<tr><td>developerName</td><td>developer name in generated pom.xml</td><td></td><td>OpenAPI-Generator Contributors</td></tr>
|
||||
<tr><td>developerOrganization</td><td>developer organization in generated pom.xml</td><td></td><td>OpenAPITools.org</td></tr>
|
||||
<tr><td>developerOrganizationUrl</td><td>developer organization URL in generated pom.xml</td><td></td><td><a href="http://openapitools.org">http://openapitools.org</a></td></tr>
|
||||
<tr><td>disableHtmlEscaping</td><td>Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>fullJavaUtil</td><td>whether to use fully qualified name for classes under java.util. This option only works for Java API client</td><td></td><td>false</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>org.openapitools</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>false</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>org.openapitools.api</td></tr>
|
||||
<tr><td>java8</td><td>Option. Use Java8 classes instead of third party equivalents</td><td><dl><dt><strong>true</strong></dt><dd>Use Java 8 classes such as Base64</dd><dt><strong>false</strong></dt><dd>Various third party libraries as needed</dd><dl></td><td>false</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>Unlicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://unlicense.org">http://unlicense.org</a></td></tr>
|
||||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>org.openapitools.model</td></tr>
|
||||
<tr><td>parentArtifactId</td><td>parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentGroupId</td><td>parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentVersion</td><td>parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>scmConnection</td><td>SCM connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmDeveloperConnection</td><td>SCM developer connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmUrl</td><td>SCM URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>false</td></tr>
|
||||
<tr><td>snapshotVersion</td><td>Uses a SNAPSHOT version.</td><td><dl><dt><strong>true</strong></dt><dd>Use a SnapShot Version</dd><dt><strong>false</strong></dt><dd>Use a Release Version</dd><dl></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src/main/groovy</td></tr>
|
||||
<tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ArrayList</td></tr>
|
||||
<tr><td>map</td><td>HashMap</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>ArrayList</li>
|
||||
<li>Boolean</li>
|
||||
<li>Date</li>
|
||||
<li>Double</li>
|
||||
<li>File</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Map</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>configuration</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>localvaraccepts</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>localvarpath</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>strictfp</li>
|
||||
<li>stringutil</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>transient</li>
|
||||
<li>try</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,250 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for haskell-http-client · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for haskell-http-client · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for haskell-http-client</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowFromJsonNulls</td><td>allow JSON Null during model decoding from JSON</td><td></td><td>true</td></tr>
|
||||
<tr><td>allowNonUniqueOperationIds</td><td>allow different API modules to contain the same operationId. Each API must be imported qualified</td><td></td><td>false</td></tr>
|
||||
<tr><td>allowToJsonNulls</td><td>allow emitting JSON Null during model encoding to JSON</td><td></td><td>false</td></tr>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>baseModule</td><td>Set the base module namespace</td><td></td><td>null</td></tr>
|
||||
<tr><td>cabalPackage</td><td>Set the cabal package name, which consists of one or more alphanumeric words separated by hyphens</td><td></td><td>null</td></tr>
|
||||
<tr><td>cabalVersion</td><td>Set the cabal version number, consisting of a sequence of one or more integers separated by dots</td><td></td><td>null</td></tr>
|
||||
<tr><td>configType</td><td>Set the name of the type used for configuration</td><td></td><td>null</td></tr>
|
||||
<tr><td>customTestInstanceModule</td><td>test module used to provide typeclass instances for types not known by the generator</td><td></td><td>null</td></tr>
|
||||
<tr><td>dateFormat</td><td>format string used to parse/render a date</td><td></td><td>%Y-%m-%d</td></tr>
|
||||
<tr><td>dateTimeFormat</td><td>format string used to parse/render a datetime</td><td></td><td>null</td></tr>
|
||||
<tr><td>dateTimeParseFormat</td><td>overrides the format string used to parse a datetime</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>generateEnums</td><td>Generate specific datatypes for OpenAPI enums</td><td></td><td>true</td></tr>
|
||||
<tr><td>generateFormUrlEncodedInstances</td><td>Generate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencoded</td><td></td><td>true</td></tr>
|
||||
<tr><td>generateLenses</td><td>Generate Lens optics for Models</td><td></td><td>true</td></tr>
|
||||
<tr><td>generateModelConstructors</td><td>Generate smart constructors (only supply required fields) for models</td><td></td><td>true</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>true</td></tr>
|
||||
<tr><td>inlineMimeTypes</td><td>Inline (hardcode) the content-type and accept parameters on operations, when there is only 1 option</td><td></td><td>true</td></tr>
|
||||
<tr><td>modelDeriving</td><td>Additional classes to include in the deriving() clause of Models</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>requestType</td><td>Set the name of the type used to generate requests</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>strictFields</td><td>Add strictness annotations to all model fields</td><td></td><td>true</td></tr>
|
||||
<tr><td>useKatip</td><td>Sets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-logger</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Bool</li>
|
||||
<li>Char</li>
|
||||
<li>Double</li>
|
||||
<li>FilePath</li>
|
||||
<li>Float</li>
|
||||
<li>Int</li>
|
||||
<li>Integer</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
<li>Text</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>accept</li>
|
||||
<li>as</li>
|
||||
<li>case</li>
|
||||
<li>class</li>
|
||||
<li>contenttype</li>
|
||||
<li>data</li>
|
||||
<li>default</li>
|
||||
<li>deriving</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>family</li>
|
||||
<li>forall</li>
|
||||
<li>foreign</li>
|
||||
<li>hiding</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>infix</li>
|
||||
<li>infixl</li>
|
||||
<li>infixr</li>
|
||||
<li>instance</li>
|
||||
<li>let</li>
|
||||
<li>mdo</li>
|
||||
<li>module</li>
|
||||
<li>newtype</li>
|
||||
<li>of</li>
|
||||
<li>proc</li>
|
||||
<li>pure</li>
|
||||
<li>qualified</li>
|
||||
<li>rec</li>
|
||||
<li>return</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>where</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,228 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for haskell · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for haskell · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for haskell</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>serveStatic</td><td>serve will serve files from the directory 'static'.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Map</td><td>qualified Data.Map as Map</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Bool</li>
|
||||
<li>Char</li>
|
||||
<li>Double</li>
|
||||
<li>FilePath</li>
|
||||
<li>Float</li>
|
||||
<li>Int</li>
|
||||
<li>Integer</li>
|
||||
<li>List</li>
|
||||
<li>String</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>as</li>
|
||||
<li>case</li>
|
||||
<li>class</li>
|
||||
<li>data</li>
|
||||
<li>default</li>
|
||||
<li>deriving</li>
|
||||
<li>do</li>
|
||||
<li>else</li>
|
||||
<li>family</li>
|
||||
<li>forall</li>
|
||||
<li>foreign</li>
|
||||
<li>hiding</li>
|
||||
<li>if</li>
|
||||
<li>import</li>
|
||||
<li>in</li>
|
||||
<li>infix</li>
|
||||
<li>infixl</li>
|
||||
<li>infixr</li>
|
||||
<li>instance</li>
|
||||
<li>let</li>
|
||||
<li>mdo</li>
|
||||
<li>module</li>
|
||||
<li>newtype</li>
|
||||
<li>of</li>
|
||||
<li>proc</li>
|
||||
<li>qualified</li>
|
||||
<li>rec</li>
|
||||
<li>then</li>
|
||||
<li>type</li>
|
||||
<li>where</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,195 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for html · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for html · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for html</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>appDescription</td><td>description of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>appName</td><td>short name of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoEmail</td><td>an email address to contact for inquiries about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoUrl</td><td>a URL where users can get more information about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseInfo</td><td>a short description of the license</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseUrl</td><td>a URL pointing to the full license</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,199 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for html2 · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for html2 · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for html2</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>appDescription</td><td>description of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>appName</td><td>short name of the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>null</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoEmail</td><td>an email address to contact for inquiries about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>infoUrl</td><td>a URL where users can get more information about the application</td><td></td><td>null</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseInfo</td><td>a short description of the license</td><td></td><td>null</td></tr>
|
||||
<tr><td>licenseUrl</td><td>a URL pointing to the full license</td><td></td><td>null</td></tr>
|
||||
<tr><td>packageName</td><td>C# package name</td><td></td><td>null</td></tr>
|
||||
<tr><td>perlModuleName</td><td>root module name for generated perl code</td><td></td><td>null</td></tr>
|
||||
<tr><td>phpInvokerPackage</td><td>root package for generated php code</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>pythonPackageName</td><td>package name for generated python code</td><td></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"></ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✓</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1,314 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for java-inflector · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for java-inflector · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for java-inflector</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>additionalModelTypeAnnotations</td><td>Additional annotations for model type(class level annotations)</td><td></td><td>null</td></tr>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>org.openapitools.controllers</td></tr>
|
||||
<tr><td>artifactDescription</td><td>artifact description in generated pom.xml</td><td></td><td>OpenAPI Java</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>openapi-inflector-server</td></tr>
|
||||
<tr><td>artifactUrl</td><td>artifact URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>bigDecimalAsString</td><td>Treat BigDecimal values as Strings to avoid precision loss.</td><td></td><td>false</td></tr>
|
||||
<tr><td>booleanGetterPrefix</td><td>Set booleanGetterPrefix</td><td></td><td>get</td></tr>
|
||||
<tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>joda</strong></dt><dd>Joda (for legacy app only)</dd><dt><strong>legacy</strong></dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt><strong>java8-localdatetime</strong></dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt><strong>java8</strong></dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt><strong>threetenbp</strong></dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl></td><td>legacy</td></tr>
|
||||
<tr><td>developerEmail</td><td>developer email in generated pom.xml</td><td></td><td><a href="mailto:team@openapitools.org">team@openapitools.org</a></td></tr>
|
||||
<tr><td>developerName</td><td>developer name in generated pom.xml</td><td></td><td>OpenAPI-Generator Contributors</td></tr>
|
||||
<tr><td>developerOrganization</td><td>developer organization in generated pom.xml</td><td></td><td>OpenAPITools.org</td></tr>
|
||||
<tr><td>developerOrganizationUrl</td><td>developer organization URL in generated pom.xml</td><td></td><td><a href="http://openapitools.org">http://openapitools.org</a></td></tr>
|
||||
<tr><td>disableHtmlEscaping</td><td>Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>fullJavaUtil</td><td>whether to use fully qualified name for classes under java.util. This option only works for Java API client</td><td></td><td>false</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>org.openapitools</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>false</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>org.openapitools.controllers</td></tr>
|
||||
<tr><td>java8</td><td>Option. Use Java8 classes instead of third party equivalents</td><td><dl><dt><strong>true</strong></dt><dd>Use Java 8 classes such as Base64</dd><dt><strong>false</strong></dt><dd>Various third party libraries as needed</dd><dl></td><td>false</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>Unlicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://unlicense.org">http://unlicense.org</a></td></tr>
|
||||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>org.openapitools.model</td></tr>
|
||||
<tr><td>parentArtifactId</td><td>parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentGroupId</td><td>parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentVersion</td><td>parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>scmConnection</td><td>SCM connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmDeveloperConnection</td><td>SCM developer connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmUrl</td><td>SCM URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>false</td></tr>
|
||||
<tr><td>snapshotVersion</td><td>Uses a SNAPSHOT version.</td><td><dl><dt><strong>true</strong></dt><dd>Use a SnapShot Version</dd><dt><strong>false</strong></dt><dd>Use a Release Version</dd><dl></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src/gen/java</td></tr>
|
||||
<tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ArrayList</td></tr>
|
||||
<tr><td>map</td><td>HashMap</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>configuration</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>localvaraccepts</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>localvarpath</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>strictfp</li>
|
||||
<li>stringutil</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>transient</li>
|
||||
<li>try</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,319 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for java-msf4j · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for java-msf4j · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for java-msf4j</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>additionalModelTypeAnnotations</td><td>Additional annotations for model type(class level annotations)</td><td></td><td>null</td></tr>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>org.openapitools.api</td></tr>
|
||||
<tr><td>artifactDescription</td><td>artifact description in generated pom.xml</td><td></td><td>OpenAPI Java</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>openapi-jaxrs-server</td></tr>
|
||||
<tr><td>artifactUrl</td><td>artifact URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>bigDecimalAsString</td><td>Treat BigDecimal values as Strings to avoid precision loss.</td><td></td><td>false</td></tr>
|
||||
<tr><td>booleanGetterPrefix</td><td>Set booleanGetterPrefix</td><td></td><td>get</td></tr>
|
||||
<tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>joda</strong></dt><dd>Joda (for legacy app only)</dd><dt><strong>legacy</strong></dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt><strong>java8-localdatetime</strong></dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt><strong>java8</strong></dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt><strong>threetenbp</strong></dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl></td><td>legacy</td></tr>
|
||||
<tr><td>developerEmail</td><td>developer email in generated pom.xml</td><td></td><td><a href="mailto:team@openapitools.org">team@openapitools.org</a></td></tr>
|
||||
<tr><td>developerName</td><td>developer name in generated pom.xml</td><td></td><td>OpenAPI-Generator Contributors</td></tr>
|
||||
<tr><td>developerOrganization</td><td>developer organization in generated pom.xml</td><td></td><td>OpenAPITools.org</td></tr>
|
||||
<tr><td>developerOrganizationUrl</td><td>developer organization URL in generated pom.xml</td><td></td><td><a href="http://openapitools.org">http://openapitools.org</a></td></tr>
|
||||
<tr><td>disableHtmlEscaping</td><td>Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>fullJavaUtil</td><td>whether to use fully qualified name for classes under java.util. This option only works for Java API client</td><td></td><td>false</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>org.openapitools</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>false</td></tr>
|
||||
<tr><td>implFolder</td><td>folder for generated implementation code</td><td></td><td>src/main/java</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>org.openapitools.api</td></tr>
|
||||
<tr><td>java8</td><td>Option. Use Java8 classes instead of third party equivalents</td><td><dl><dt><strong>true</strong></dt><dd>Use Java 8 classes such as Base64</dd><dt><strong>false</strong></dt><dd>Various third party libraries as needed</dd><dl></td><td>false</td></tr>
|
||||
<tr><td>library</td><td>library template (sub-template)</td><td><dl><dt><strong>jersey1</strong></dt><dd>Jersey core 1.x</dd><dt><strong>jersey2</strong></dt><dd>Jersey core 2.x</dd><dl></td><td>jersey2</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>Unlicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://unlicense.org">http://unlicense.org</a></td></tr>
|
||||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>org.openapitools.model</td></tr>
|
||||
<tr><td>parentArtifactId</td><td>parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentGroupId</td><td>parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentVersion</td><td>parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>scmConnection</td><td>SCM connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmDeveloperConnection</td><td>SCM developer connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmUrl</td><td>SCM URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>false</td></tr>
|
||||
<tr><td>serverPort</td><td>The port on which the server should be started</td><td></td><td>8080</td></tr>
|
||||
<tr><td>snapshotVersion</td><td>Uses a SNAPSHOT version.</td><td><dl><dt><strong>true</strong></dt><dd>Use a SnapShot Version</dd><dt><strong>false</strong></dt><dd>Use a Release Version</dd><dl></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src/main/java</td></tr>
|
||||
<tr><td>title</td><td>a title describing the application</td><td></td><td>OpenAPI Server</td></tr>
|
||||
<tr><td>useBeanValidation</td><td>Use BeanValidation API annotations</td><td></td><td>true</td></tr>
|
||||
<tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ArrayList</td></tr>
|
||||
<tr><td>map</td><td>HashMap</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>configuration</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>localvaraccepts</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>localvarpath</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>strictfp</li>
|
||||
<li>stringutil</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>transient</li>
|
||||
<li>try</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
File diff suppressed because one or more lines are too long
@@ -1,321 +0,0 @@
|
||||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Config Options for java-pkmst · OpenAPI Generator</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="| Option | Description | Values | Default |"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Config Options for java-pkmst · OpenAPI Generator"/><meta property="og:type" content="website"/><meta property="og:url" content="https://openapi-generator.tech/"/><meta property="og:description" content="| Option | Description | Values | Default |"/><meta property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://openapi-generator.tech/img/icons/twitter.svg"/><link rel="shortcut icon" href="/img/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><link rel="alternate" type="application/atom+xml" href="https://openapi-generator.tech/blog/atom.xml" title="OpenAPI Generator Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://openapi-generator.tech/blog/feed.xml" title="OpenAPI Generator Blog RSS Feed"/><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
|
||||
|
||||
ga('create', 'UA-132927057-1', 'auto');
|
||||
ga('send', 'pageview');
|
||||
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-block-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
{"zIndex":100}
|
||||
)
|
||||
});
|
||||
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/"><img class="logo" src="/img/mono-logo.svg" alt="OpenAPI Generator"/><h2 class="headerTitleWithLogo">OpenAPI Generator</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/installation" target="_self">Get Started</a></li><li class=""><a href="/docs/generators" target="_self">Generators</a></li><li class=""><a href="/docs/roadmap" target="_self">Roadmap</a></li><li class=""><a href="/team" target="_self">Team</a></li><li class=""><a href="/docs/faq" target="_self">FAQ</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1 id="__docusaurus" class="postHeaderTitle">Config Options for java-pkmst</h1></header><article><div><span><table>
|
||||
<thead>
|
||||
<tr><th>Option</th><th>Description</th><th>Values</th><th>Default</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>additionalModelTypeAnnotations</td><td>Additional annotations for model type(class level annotations)</td><td></td><td>null</td></tr>
|
||||
<tr><td>allowUnicodeIdentifiers</td><td>boolean, toggles whether unicode identifiers are allowed in names or not, default is false</td><td></td><td>false</td></tr>
|
||||
<tr><td>apiPackage</td><td>package for generated api classes</td><td></td><td>com.prokarma.pkmst.controller</td></tr>
|
||||
<tr><td>artifactDescription</td><td>artifact description in generated pom.xml</td><td></td><td>OpenAPI Java</td></tr>
|
||||
<tr><td>artifactId</td><td>artifactId in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>pkmst-microservice</td></tr>
|
||||
<tr><td>artifactUrl</td><td>artifact URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>artifactVersion</td><td>artifact version in generated pom.xml. This also becomes part of the generated library's filename</td><td></td><td>1.0.0</td></tr>
|
||||
<tr><td>basePackage</td><td>base package for java source code</td><td></td><td>null</td></tr>
|
||||
<tr><td>bigDecimalAsString</td><td>Treat BigDecimal values as Strings to avoid precision loss.</td><td></td><td>false</td></tr>
|
||||
<tr><td>booleanGetterPrefix</td><td>Set booleanGetterPrefix</td><td></td><td>get</td></tr>
|
||||
<tr><td>dateLibrary</td><td>Option. Date library to use</td><td><dl><dt><strong>joda</strong></dt><dd>Joda (for legacy app only)</dd><dt><strong>legacy</strong></dt><dd>Legacy java.util.Date (if you really have a good reason not to use threetenbp</dd><dt><strong>java8-localdatetime</strong></dt><dd>Java 8 using LocalDateTime (for legacy app only)</dd><dt><strong>java8</strong></dt><dd>Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true</dd><dt><strong>threetenbp</strong></dt><dd>Backport of JSR310 (preferred for jdk < 1.8)</dd><dl></td><td>threetenbp</td></tr>
|
||||
<tr><td>developerEmail</td><td>developer email in generated pom.xml</td><td></td><td><a href="mailto:team@openapitools.org">team@openapitools.org</a></td></tr>
|
||||
<tr><td>developerName</td><td>developer name in generated pom.xml</td><td></td><td>OpenAPI-Generator Contributors</td></tr>
|
||||
<tr><td>developerOrganization</td><td>developer organization in generated pom.xml</td><td></td><td>OpenAPITools.org</td></tr>
|
||||
<tr><td>developerOrganizationUrl</td><td>developer organization URL in generated pom.xml</td><td></td><td><a href="http://openapitools.org">http://openapitools.org</a></td></tr>
|
||||
<tr><td>disableHtmlEscaping</td><td>Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields)</td><td></td><td>false</td></tr>
|
||||
<tr><td>ensureUniqueParams</td><td>Whether to ensure parameter names are unique in an operation (rename parameters that are not).</td><td></td><td>true</td></tr>
|
||||
<tr><td>eurekaUri</td><td>Eureka URI</td><td></td><td>null</td></tr>
|
||||
<tr><td>fullJavaUtil</td><td>whether to use fully qualified name for classes under java.util. This option only works for Java API client</td><td></td><td>false</td></tr>
|
||||
<tr><td>groupId</td><td>groupId in generated pom.xml</td><td></td><td>com.prokarma</td></tr>
|
||||
<tr><td>hideGenerationTimestamp</td><td>Hides the generation timestamp when files are generated.</td><td></td><td>false</td></tr>
|
||||
<tr><td>invokerPackage</td><td>root package for generated code</td><td></td><td>com.prokarma.pkmst.controller</td></tr>
|
||||
<tr><td>java8</td><td>Option. Use Java8 classes instead of third party equivalents</td><td><dl><dt><strong>true</strong></dt><dd>Use Java 8 classes such as Base64</dd><dt><strong>false</strong></dt><dd>Various third party libraries as needed</dd><dl></td><td>false</td></tr>
|
||||
<tr><td>licenseName</td><td>The name of the license</td><td></td><td>Unlicense</td></tr>
|
||||
<tr><td>licenseUrl</td><td>The URL of the license</td><td></td><td><a href="http://unlicense.org">http://unlicense.org</a></td></tr>
|
||||
<tr><td>modelPackage</td><td>package for generated models</td><td></td><td>com.prokarma.pkmst.model</td></tr>
|
||||
<tr><td>parentArtifactId</td><td>parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentGroupId</td><td>parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>parentVersion</td><td>parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect</td><td></td><td>null</td></tr>
|
||||
<tr><td>pkmstInterceptor</td><td>PKMST Interceptor</td><td></td><td>null</td></tr>
|
||||
<tr><td>prependFormOrBodyParameters</td><td>Add form or body parameters to the beginning of the parameter list.</td><td></td><td>false</td></tr>
|
||||
<tr><td>scmConnection</td><td>SCM connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmDeveloperConnection</td><td>SCM developer connection in generated pom.xml</td><td></td><td>scm:git:<a href="mailto:git@github.com">git@github.com</a>:openapitools/openapi-generator.git</td></tr>
|
||||
<tr><td>scmUrl</td><td>SCM URL in generated pom.xml</td><td></td><td><a href="https://github.com/openapitools/openapi-generator">https://github.com/openapitools/openapi-generator</a></td></tr>
|
||||
<tr><td>serializableModel</td><td>boolean - toggle "implements Serializable" for generated models</td><td></td><td>false</td></tr>
|
||||
<tr><td>serviceName</td><td>Service Name</td><td></td><td>null</td></tr>
|
||||
<tr><td>snapshotVersion</td><td>Uses a SNAPSHOT version.</td><td><dl><dt><strong>true</strong></dt><dd>Use a SnapShot Version</dd><dt><strong>false</strong></dt><dd>Use a Release Version</dd><dl></td><td>null</td></tr>
|
||||
<tr><td>sortModelPropertiesByRequiredFlag</td><td>Sort model properties to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sortParamsByRequiredFlag</td><td>Sort method arguments to place required parameters before optional parameters.</td><td></td><td>true</td></tr>
|
||||
<tr><td>sourceFolder</td><td>source folder for generated code</td><td></td><td>src/main/java</td></tr>
|
||||
<tr><td>springBootAdminUri</td><td>Spring-Boot URI</td><td></td><td>null</td></tr>
|
||||
<tr><td>title</td><td>server title name or client service name</td><td></td><td>null</td></tr>
|
||||
<tr><td>withXml</td><td>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)</td><td></td><td>false</td></tr>
|
||||
<tr><td>zipkinUri</td><td>Zipkin URI</td><td></td><td>null</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="import-mapping"></a><a href="#import-mapping" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>IMPORT MAPPING</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Imports</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Array</td><td>java.util.List</td></tr>
|
||||
<tr><td>ArrayList</td><td>java.util.ArrayList</td></tr>
|
||||
<tr><td>BigDecimal</td><td>java.math.BigDecimal</td></tr>
|
||||
<tr><td>Date</td><td>java.util.Date</td></tr>
|
||||
<tr><td>DateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>File</td><td>java.io.File</td></tr>
|
||||
<tr><td>HashMap</td><td>java.util.HashMap</td></tr>
|
||||
<tr><td>List</td><td>java.util.*</td></tr>
|
||||
<tr><td>LocalDate</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalDateTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>LocalTime</td><td>org.joda.time.*</td></tr>
|
||||
<tr><td>Map</td><td>java.util.Map</td></tr>
|
||||
<tr><td>Set</td><td>java.util.*</td></tr>
|
||||
<tr><td>Timestamp</td><td>java.sql.Timestamp</td></tr>
|
||||
<tr><td>URI</td><td>java.net.URI</td></tr>
|
||||
<tr><td>UUID</td><td>java.util.UUID</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="instantiation-types"></a><a href="#instantiation-types" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>INSTANTIATION TYPES</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Type/Alias</th><th>Instantiated By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>array</td><td>ArrayList</td></tr>
|
||||
<tr><td>map</td><td>HashMap</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2><a class="anchor" aria-hidden="true" id="language-primitives"></a><a href="#language-primitives" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>LANGUAGE PRIMITIVES</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>Boolean</li>
|
||||
<li>Double</li>
|
||||
<li>Float</li>
|
||||
<li>Integer</li>
|
||||
<li>Long</li>
|
||||
<li>Object</li>
|
||||
<li>String</li>
|
||||
<li>boolean</li>
|
||||
<li>byte[]</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reserved-words"></a><a href="#reserved-words" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>RESERVED WORDS</h2>
|
||||
<ul data-columns="2" style="list-style-type: disc;-webkit-columns:2;-moz-columns:2;columns:2;-moz-column-fill:auto;column-fill:auto"><li>abstract</li>
|
||||
<li>apiclient</li>
|
||||
<li>apiexception</li>
|
||||
<li>apiresponse</li>
|
||||
<li>assert</li>
|
||||
<li>boolean</li>
|
||||
<li>break</li>
|
||||
<li>byte</li>
|
||||
<li>case</li>
|
||||
<li>catch</li>
|
||||
<li>char</li>
|
||||
<li>class</li>
|
||||
<li>configuration</li>
|
||||
<li>const</li>
|
||||
<li>continue</li>
|
||||
<li>default</li>
|
||||
<li>do</li>
|
||||
<li>double</li>
|
||||
<li>else</li>
|
||||
<li>enum</li>
|
||||
<li>extends</li>
|
||||
<li>final</li>
|
||||
<li>finally</li>
|
||||
<li>float</li>
|
||||
<li>for</li>
|
||||
<li>goto</li>
|
||||
<li>if</li>
|
||||
<li>implements</li>
|
||||
<li>import</li>
|
||||
<li>instanceof</li>
|
||||
<li>int</li>
|
||||
<li>interface</li>
|
||||
<li>localreturntype</li>
|
||||
<li>localvaraccept</li>
|
||||
<li>localvaraccepts</li>
|
||||
<li>localvarauthnames</li>
|
||||
<li>localvarcollectionqueryparams</li>
|
||||
<li>localvarcontenttype</li>
|
||||
<li>localvarcontenttypes</li>
|
||||
<li>localvarcookieparams</li>
|
||||
<li>localvarformparams</li>
|
||||
<li>localvarheaderparams</li>
|
||||
<li>localvarpath</li>
|
||||
<li>localvarpostbody</li>
|
||||
<li>localvarqueryparams</li>
|
||||
<li>long</li>
|
||||
<li>native</li>
|
||||
<li>new</li>
|
||||
<li>null</li>
|
||||
<li>object</li>
|
||||
<li>package</li>
|
||||
<li>private</li>
|
||||
<li>protected</li>
|
||||
<li>public</li>
|
||||
<li>return</li>
|
||||
<li>short</li>
|
||||
<li>static</li>
|
||||
<li>strictfp</li>
|
||||
<li>stringutil</li>
|
||||
<li>super</li>
|
||||
<li>switch</li>
|
||||
<li>synchronized</li>
|
||||
<li>this</li>
|
||||
<li>throw</li>
|
||||
<li>throws</li>
|
||||
<li>transient</li>
|
||||
<li>try</li>
|
||||
<li>void</li>
|
||||
<li>volatile</li>
|
||||
<li>while</li>
|
||||
</ul>
|
||||
<h2><a class="anchor" aria-hidden="true" id="feature-set"></a><a href="#feature-set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>FEATURE SET</h2>
|
||||
<h3><a class="anchor" aria-hidden="true" id="client-modification-feature"></a><a href="#client-modification-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Client Modification Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasePath</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Authorizations</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>UserAgent</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="data-type-feature"></a><a href="#data-type-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Data Type Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int32</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Int64</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Float</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Double</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Decimal</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>String</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Byte</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Binary</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Boolean</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Date</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>DateTime</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Password</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>File</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Maps</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>CollectionFormat</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>CollectionFormatMulti</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Enum</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ArrayOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>ArrayOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfPrimitives</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfModel</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>MapOfCollectionOfEnum</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="documentation-feature"></a><a href="#documentation-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documentation Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Readme</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Model</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Api</td><td>✓</td><td>ToolingExtension</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="global-feature"></a><a href="#global-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Global Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Host</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>BasePath</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Info</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Schemes</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PartialSchemes</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Consumes</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Produces</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>ExternalDocumentation</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Examples</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XMLStructureDefinitions</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>MultiServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterizedServer</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>ParameterStyling</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>Callbacks</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>LinkObjects</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="parameter-feature"></a><a href="#parameter-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Parameter Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Path</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Query</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Header</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Body</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormUnencoded</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>FormMultipart</td><td>✓</td><td>OAS2</td></tr>
|
||||
<tr><td>Cookie</td><td>✓</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="schema-support-feature"></a><a href="#schema-support-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Schema Support Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>Simple</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Composite</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Polymorphism</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>Union</td><td>✗</td><td>OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="security-feature"></a><a href="#security-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Security Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>BasicAuth</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>ApiKey</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OpenIDConnect</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>BearerToken</td><td>✗</td><td>OAS3</td></tr>
|
||||
<tr><td>OAuth2_Implicit</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_Password</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_ClientCredentials</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>OAuth2_AuthorizationCode</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3><a class="anchor" aria-hidden="true" id="wire-format-feature"></a><a href="#wire-format-feature" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Wire Format Feature</h3>
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Name</th><th>Supported</th><th>Defined By</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td>JSON</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>XML</td><td>✓</td><td>OAS2,OAS3</td></tr>
|
||||
<tr><td>PROTOBUF</td><td>✗</td><td>ToolingExtension</td></tr>
|
||||
<tr><td>Custom</td><td>✗</td><td>OAS2,OAS3</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2/2/2020</em></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#import-mapping">IMPORT MAPPING</a></li><li><a href="#instantiation-types">INSTANTIATION TYPES</a></li><li><a href="#language-primitives">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words">RESERVED WORDS</a></li><li><a href="#feature-set">FEATURE SET</a><ul class="toc-headings"><li><a href="#client-modification-feature">Client Modification Feature</a></li><li><a href="#data-type-feature">Data Type Feature</a></li><li><a href="#documentation-feature">Documentation Feature</a></li><li><a href="#global-feature">Global Feature</a></li><li><a href="#parameter-feature">Parameter Feature</a></li><li><a href="#schema-support-feature">Schema Support Feature</a></li><li><a href="#security-feature">Security Feature</a></li><li><a href="#wire-format-feature">Wire Format Feature</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/mono-logo.svg" alt="OpenAPI Generator" width="66" height="58"/></a><div><h5>Docs</h5><a href="/docs/en/customization.html">Customizing Generators</a><a href="/docs/en/integrations.html">Workflow Integrations</a></div><div><h5>Community</h5><a href="/en/users.html">User Showcase</a><a href="http://stackoverflow.com/questions/tagged/openapi-generator" target="_blank" rel="noreferrer noopener">Stack Overflow</a><a href="https://join.slack.com/t/openapi-generator/shared_invite/enQtNzAyNDMyOTU0OTE1LTY5ZDBiNDI5NzI5ZjQ1Y2E5OWVjMjZkYzY1ZGM2MWQ4YWFjMzcyNDY5MGI4NjQxNDBiMTlmZTc5NjY2ZTQ5MGM">Chat Room</a><a href="https://twitter.com/oas_generator" target="_blank" rel="noreferrer noopener">Twitter</a></div><div><h5>More</h5><a href="/blog">Blog</a><a href="https://github.com/OpenAPITools/openapi-generator">GitHub Repo</a><a class="github-button" href="https://github.com/OpenAPITools/openapi-generator" data-icon="octicon-star" data-count-href="/OpenAPITools/openapi-generator/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">Star</a></div></section><section class="copyright">Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user