Deploy website

Deploy website version based on c89d21a903
2019-11-22 03:49:30 +00:00
parent 07f2676674
commit 0f705fbd11
2 changed files with 148 additions and 2 deletions
--- a/docs/usage.html
+++ b/docs/usage.html
@@ -522,4 +522,77 @@ The name of the file should be <code>config.yml</code> or <code>config.yaml</cod
 <pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
    -c config.yaml
 </code></pre>
-</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-11-13</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/templating"><span>Using Templates</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</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 © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
+<h2><a class="anchor" aria-hidden="true" id="batch"></a><a href="#batch" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>batch</h2>
+<p>The <code>batch</code> command allows you to move all CLI arguments supported by the <code>generate</code> command into a YAML or JSON file.</p>
+<p><em>NOTE</em>: This command supports an additional <code>!include</code> property which may point to another &quot;shared&quot; file, the base path to which can be
+modified by <code>--includes-base-dir</code>.</p>
+<pre><code class="hljs css language-bash">openapi-generator <span class="hljs-built_in">help</span> batch
+NAME
+        openapi-generator-cli batch - Generate code <span class="hljs-keyword">in</span> batch via external
+        configs.
+
+SYNOPSIS
+        openapi-generator-cli batch [--fail-fast]
+                [--includes-base-dir &lt;includes&gt;] [(-r &lt;threads&gt; | --threads &lt;threads&gt;)]
+                [--root-dir &lt;root&gt;] [--timeout &lt;timeout&gt;] [(-v | --verbose)] [--]
+                &lt;configs&gt;...
+
+OPTIONS
+        --fail-fast
+            fail fast on any errors
+
+        --includes-base-dir &lt;includes&gt;
+            base directory used <span class="hljs-keyword">for</span> includes
+
+        -r &lt;threads&gt;, --threads &lt;threads&gt;
+            thread count
+
+        --root-dir &lt;root&gt;
+            root directory used output/includes (includes can be overridden)
+
+        --timeout &lt;timeout&gt;
+            execution timeout (minutes)
+
+        -v, --verbose
+            verbose mode
+
+        --
+            This option can be used to separate <span class="hljs-built_in">command</span>-line options from the
+            list of argument, (useful when arguments might be mistaken <span class="hljs-keyword">for</span>
+            <span class="hljs-built_in">command</span>-line options
+
+        &lt;configs&gt;
+            Generator configuration files.
+</code></pre>
+<p>Example:</p>
+<pre><code class="hljs css language-bash"><span class="hljs-comment"># create "shared" config</span>
+mkdir shared &amp;&amp; cat &gt; shared/common.yaml &lt;&lt;EOF
+inputSpec: https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/<span class="hljs-built_in">test</span>/resources/2_0/petstore.yaml
+additionalProperties:
+    x-ext-name: <span class="hljs-string">"Your Name"</span>
+EOF
+
+<span class="hljs-comment"># create "standard" configs</span>
+cat &gt; kotlin.yaml &lt;&lt;EOF
+<span class="hljs-string">'!include'</span>: <span class="hljs-string">'shared/common.yaml'</span>
+outputDir: out/kotlin
+generatorName: kotlin
+artifactId: kotlin-petstore-string
+additionalProperties:
+  dateLibrary: string
+  serializableModel: <span class="hljs-string">"true"</span>
+EOF
+
+cat &gt; csharp.yaml &lt;&lt;EOF
+<span class="hljs-string">'!include'</span>: <span class="hljs-string">'shared/common.yaml'</span>
+outputDir: out/csharp-netcore
+generatorName: csharp-netcore
+additionalProperties:
+  packageGuid: <span class="hljs-string">"{321C8C3F-0156-40C1-AE42-D59761FB9B6C}"</span>
+  useCompareNetObjects: <span class="hljs-string">"true"</span>
+EOF
+
+<span class="hljs-comment"># Generate them</span>
+openapi-generator batch *.yaml
+</code></pre>
+</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-11-22</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/templating"><span>Using Templates</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</a></li></ul></li><li><a href="#batch">batch</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 © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
--- a/docs/usage/index.html
+++ b/docs/usage/index.html
@@ -522,4 +522,77 @@ The name of the file should be <code>config.yml</code> or <code>config.yaml</cod
 <pre><code class="hljs css language-bash">openapi-generator generate -i petstore.yaml -g typescript-fetch -o out \
    -c config.yaml
 </code></pre>
-</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-11-13</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/templating"><span>Using Templates</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</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 © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>
+<h2><a class="anchor" aria-hidden="true" id="batch"></a><a href="#batch" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>batch</h2>
+<p>The <code>batch</code> command allows you to move all CLI arguments supported by the <code>generate</code> command into a YAML or JSON file.</p>
+<p><em>NOTE</em>: This command supports an additional <code>!include</code> property which may point to another &quot;shared&quot; file, the base path to which can be
+modified by <code>--includes-base-dir</code>.</p>
+<pre><code class="hljs css language-bash">openapi-generator <span class="hljs-built_in">help</span> batch
+NAME
+        openapi-generator-cli batch - Generate code <span class="hljs-keyword">in</span> batch via external
+        configs.
+
+SYNOPSIS
+        openapi-generator-cli batch [--fail-fast]
+                [--includes-base-dir &lt;includes&gt;] [(-r &lt;threads&gt; | --threads &lt;threads&gt;)]
+                [--root-dir &lt;root&gt;] [--timeout &lt;timeout&gt;] [(-v | --verbose)] [--]
+                &lt;configs&gt;...
+
+OPTIONS
+        --fail-fast
+            fail fast on any errors
+
+        --includes-base-dir &lt;includes&gt;
+            base directory used <span class="hljs-keyword">for</span> includes
+
+        -r &lt;threads&gt;, --threads &lt;threads&gt;
+            thread count
+
+        --root-dir &lt;root&gt;
+            root directory used output/includes (includes can be overridden)
+
+        --timeout &lt;timeout&gt;
+            execution timeout (minutes)
+
+        -v, --verbose
+            verbose mode
+
+        --
+            This option can be used to separate <span class="hljs-built_in">command</span>-line options from the
+            list of argument, (useful when arguments might be mistaken <span class="hljs-keyword">for</span>
+            <span class="hljs-built_in">command</span>-line options
+
+        &lt;configs&gt;
+            Generator configuration files.
+</code></pre>
+<p>Example:</p>
+<pre><code class="hljs css language-bash"><span class="hljs-comment"># create "shared" config</span>
+mkdir shared &amp;&amp; cat &gt; shared/common.yaml &lt;&lt;EOF
+inputSpec: https://raw.githubusercontent.com/OpenAPITools/openapi-generator/master/modules/openapi-generator/src/<span class="hljs-built_in">test</span>/resources/2_0/petstore.yaml
+additionalProperties:
+    x-ext-name: <span class="hljs-string">"Your Name"</span>
+EOF
+
+<span class="hljs-comment"># create "standard" configs</span>
+cat &gt; kotlin.yaml &lt;&lt;EOF
+<span class="hljs-string">'!include'</span>: <span class="hljs-string">'shared/common.yaml'</span>
+outputDir: out/kotlin
+generatorName: kotlin
+artifactId: kotlin-petstore-string
+additionalProperties:
+  dateLibrary: string
+  serializableModel: <span class="hljs-string">"true"</span>
+EOF
+
+cat &gt; csharp.yaml &lt;&lt;EOF
+<span class="hljs-string">'!include'</span>: <span class="hljs-string">'shared/common.yaml'</span>
+outputDir: out/csharp-netcore
+generatorName: csharp-netcore
+additionalProperties:
+  packageGuid: <span class="hljs-string">"{321C8C3F-0156-40C1-AE42-D59761FB9B6C}"</span>
+  useCompareNetObjects: <span class="hljs-string">"true"</span>
+EOF
+
+<span class="hljs-comment"># Generate them</span>
+openapi-generator batch *.yaml
+</code></pre>
+</span></div></article></div><div class="docLastUpdate"><em>Last updated on 2019-11-22</em></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/online"><span class="arrow-prev">← </span><span>Online</span></a><a class="docs-next button" href="/docs/templating"><span>Using Templates</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#help">help</a></li><li><a href="#list">list</a></li><li><a href="#config-help">config-help</a></li><li><a href="#meta">meta</a></li><li><a href="#validate">validate</a></li><li><a href="#completion">completion</a></li><li><a href="#generate">generate</a><ul class="toc-headings"><li><a href="#examples">Examples</a></li><li><a href="#target-external-models">Target External Models</a></li></ul></li><li><a href="#batch">batch</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 © 2019 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both &quot;OpenAPI Tools&quot; (https://OpenAPITools.org) and &quot;OpenAPI Generator&quot; are not affiliated with OpenAPI Initiative (OAI))</section></footer></div></body></html>