loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/cpp-qt-client/index.html

55 lines
26 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width">
<meta name="generator" content="Docusaurus">
<link rel="preconnect" href="https://www.google-analytics.com">
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
<link rel="preconnect" href="https://www.google-analytics.com">
<script>window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)},ga.l=+new Date,ga("create","UA-132927057-1","auto"),ga("send","pageview")</script>
<script async src="https://www.google-analytics.com/analytics.js"></script>
<script src="https://buttons.github.io/buttons.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script>
<script src="/js/code-block-buttons.js"></script>
<title data-react-helmet="true">Documentation for the cpp-qt-client Generator</title>
<meta data-react-helmet="true" http-equiv="x-ua-compatible" content="ie=edge"><meta data-react-helmet="true" property="og:title" content="OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" property="og:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" property="twitter:image" content="https://openapi-generator.tech/img/docusaurus.png"><meta data-react-helmet="true" name="twitter:image:alt" content="Image for OpenAPI Generator · Generate clients, servers, and documentation from OpenAPI 2.0/3.x documents"><meta data-react-helmet="true" name="twitter:card" content="summary"><meta data-react-helmet="true" name="description" content="## METADATA"><meta data-react-helmet="true" property="og:description" content="## METADATA"><meta data-react-helmet="true" property="og:url" content="https://openapi-generator.tech/docs/generators/cpp-qt-client">
<link data-react-helmet="true" rel="shortcut icon" href="/img/favicon.png">
<link rel="stylesheet" href="/styles.7682a635.css">
</head>
<body>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}function e(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}var n=window.matchMedia("(prefers-color-scheme: dark)");n.addListener((function(n){null===e()&&t(n.matches?"dark":"")}));var a=e();null!==a?t(a):n.matches&&t("dark")}()</script>
<div id="__docusaurus">
<nav class="navbar navbar--light navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><div aria-label="Navigation bar toggle" class="navbar__toggle" role="button" tabindex="0"><svg xmlns="http://www.w3.org/2000/svg" width="30" height="30" viewBox="0 0 30 30" role="img" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></div><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a><a class="navbar__item navbar__link" href="/docs/installation">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/docs/generators">Generators</a><a class="navbar__item navbar__link" href="/docs/roadmap">Roadmap</a><a class="navbar__item navbar__link" href="/docs/faq">FAQ</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></div><div class="navbar__items navbar__items--right"><div class="react-toggle react-toggle--disabled displayOnlyInLargeViewport_1gtM"><div class="react-toggle-track"><div class="react-toggle-track-check"><span class="toggle_keGJ moon_1gwN"></span></div><div class="react-toggle-track-x"><span class="toggle_keGJ sun_3CPA"></span></div></div><div class="react-toggle-thumb"></div><input type="checkbox" disabled="" aria-label="Dark mode toggle" class="react-toggle-screenreader-only"></div><div class="navbar__search"><span aria-label="expand searchbar" role="button" class="search-icon" tabindex="0"></span><input type="search" id="search_input_react" placeholder="Search" aria-label="Search" class="navbar__search-input search-bar"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div><div class="navbar-sidebar"><div class="navbar-sidebar__brand"><a aria-current="page" class="navbar__brand active" href="/"><img class="navbar__logo" src="/img/mono-logo.svg" alt="OpenAPI Tools logo"><strong>OpenAPI Generator</strong></a></div><div class="navbar-sidebar__items"><div class="menu"><ul class="menu__list"><li class="menu__list-item"><a class="menu__link" href="/docs/installation">Getting Started</a></li><li class="menu__list-item"><a aria-current="page" class="menu__link navbar__link--active" href="/docs/generators">Generators</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/roadmap">Roadmap</a></li><li class="menu__list-item"><a class="menu__link" href="/docs/faq">FAQ</a></li><li class="menu__list-item"><a class="menu__link" href="/team">Team</a></li><li class="menu__list-item"><a class="menu__link" href="/blog">Blog</a></li><li class="menu__list-item"><a class="menu__link" activeclassname="navbar__link--active" to="https://api.openapi-generator.tech" href="https://api.openapi-generator.tech">API</a></li></ul></div></div></div></nav><div class="main-wrapper"><div class="docPage_1kjD"><main class="docMainContainer_FFX1"><div class="padding-vert--lg"><div class="container"><div class="row"><div class="col"><div class="docItemContainer_2cwg"><article><header><h1 class="docTitle_1vWb">Documentation for the cpp-qt-client Generator</h1></header><div class="markdown"><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="metadata"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#metadata" title="Direct link to heading">#</a>METADATA</h2><table><thead><tr><th>Property</th><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td>generator name</td><td>cpp-qt-client</td><td>pass this to the generate command after -g</td></tr><tr><td>generator stability</td><td>STABLE</td><td></td></tr><tr><td>generator type</td><td>CLIENT</td><td></td></tr><tr><td>generator language</td><td>C++</td><td></td></tr><tr><td>generator default templating engine</td><td>mustache</td><td></td></tr><tr><td>helpTxt</td><td>Generates a Qt C++ client library.</td><td></td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="config-options"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#config-options" title="Direct link to heading">#</a>CONFIG OPTIONS</h2><p>These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to <a href="https://openapi-generator.tech/docs/configuration">configuration docs</a> for more details.</p><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>disallowAdditionalPropertiesIfNotPresent</td><td>If false, the &#x27;additionalProperties&#x27; implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that &#x27;additionalProperties&#x27; is set to false by default.</td><td><dl><dt><strong>false</strong></dt><dd>The &#x27;additionalProperties&#x27; implementation is compliant with the OAS and JSON schema specifications.</dd><dt><strong>true</strong></dt><dd>Keep the old (incorrect) behaviour that &#x27;additionalProperties&#x27; is set to false by default.</dd></dl></td><td>true</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>enumUnknownDefaultCase</td><td>If the server adds new enum cases, that are unknown by an old spec/client, the client will fail to parse the network response.With this option enabled, each enum will have a new case, &#x27;unknown_default_open_api&#x27;, so that when the server sends an enum case that is not known by the client/spec, they can safely fallback to this case.</td><td><dl><dt><strong>false</strong></dt><dd>No changes to the enum&#x27;s are made, this is the default option.</dd><dt><strong>true</strong></dt><dd>With this option enabled, each enum will have a new case, &#x27;unknown_default_open_api&#x27;, so that when the enum case sent by the server is not known by the client/spec, can safely be decoded to this case.</dd></dl></td><td>false</td></tr><tr><td>legacyDiscriminatorBehavior</td><td>Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).</td><td><dl><dt><strong>true</strong></dt><dd>The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document.</dd><dt><strong>false</strong></dt><dd>The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing.</dd></dl></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>reservedWordPrefix</td><td>Prefix to prepend to reserved words in order to avoid conflicts</td><td></td><td>r_</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>variableNameFirstCharacterUppercase</td><td>Make first character of variable name uppercase (eg. value -&gt; Value)</td><td></td><td>true</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="import-mapping"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#import-mapping" title="Direct link to heading">#</a>IMPORT MAPPING</h2><table><thead><tr><th>Type/Alias</th><th>Imports</th></tr></thead><tbody><tr><td>OAIHttpFileElement</td><td>#include &quot;OAIHttpFileElement.h&quot;</td></tr><tr><td>QJsonValue</td><td>#include &lt;QJsonValue&gt;</td></tr></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="instantiation-types"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#instantiation-types" title="Direct link to heading">#</a>INSTANTIATION TYPES</h2><table><thead><tr><th>Type/Alias</th><th>Instantiated By</th></tr></thead><tbody></tbody></table><h2><a aria-hidden="true" tabindex="-1" class="anchor" id="language-primitives"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#language-primitives" title="Direct link to heading">#</a>LANGUAGE PRIMITIVES</h2><ul class="column-ul"><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 aria-hidden="true" tabindex="-1" class="anchor" id="reserved-words"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#reserved-words" title="Direct link to heading">#</a>RESERVED WORDS</h2><ul class="column-ul"><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 aria-hidden="true" tabindex="-1" class="anchor" id="feature-set"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#feature-set" title="Direct link to heading">#</a>FEATURE SET</h2><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="client-modification-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#client-modification-feature" title="Direct link to heading">#</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><tr><td>MockServer</td><td>✗</td><td>ToolingExtension</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="data-type-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#data-type-feature" title="Direct link to heading">#</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>Uuid</td><td>✗</td><td></td></tr><tr><td>Array</td><td>✓</td><td>OAS2,OAS3</td></tr><tr><td>Null</td><td>✗</td><td>OAS3</td></tr><tr><td>AnyType</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>Object</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 aria-hidden="true" tabindex="-1" class="anchor" id="documentation-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#documentation-feature" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="global-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#global-feature" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="parameter-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#parameter-feature" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="schema-support-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#schema-support-feature" title="Direct link to heading">#</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><tr><td>allOf</td><td>✗</td><td>OAS2,OAS3</td></tr><tr><td>anyOf</td><td>✗</td><td>OAS3</td></tr><tr><td>oneOf</td><td>✗</td><td>OAS3</td></tr><tr><td>not</td><td>✗</td><td>OAS3</td></tr></tbody></table><h3><a aria-hidden="true" tabindex="-1" class="anchor" id="security-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#security-feature" title="Direct link to heading">#</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 aria-hidden="true" tabindex="-1" class="anchor" id="wire-format-feature"></a><a aria-hidden="true" tabindex="-1" class="hash-link" href="#wire-format-feature" title="Direct link to heading">#</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></div></article><div class="margin-vert--xl"><div class="row"><div class="col"><a href="https://github.com/OpenAPITools/openapi-generator/edit/master/website/../docs/generators/cpp-qt-client.md" target="_blank" rel="noreferrer noopener"><svg fill="currentColor" height="1.2em" width="1.2em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 40 40" style="margin-right:0.3em;vertical-align:sub"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col text--right"><em><small>Last updated on <time datetime="2022-12-17T07:40:14.000Z" class="docLastUpdatedAt_1sqk">2022-12-17</time> by <strong>John Mitchell</strong></small></em></div></div></div><div class="margin-vert--lg"><nav class="pagination-nav"><div class="pagination-nav__item"></div><div class="pagination-nav__item pagination-nav__item--next"></div></nav></div></div></div><div class="col col--3"><div class="tableOfContents_TbNY"><ul class="contents contents__left-border"><li><a href="#metadata" class="contents__link">METADATA</a></li><li><a href="#config-options" class="contents__link">CONFIG OPTIONS</a></li><li><a href="#import-mapping" class="contents__link">IMPORT MAPPING</a></li><li><a href="#instantiation-types" class="contents__link">INSTANTIATION TYPES</a></li><li><a href="#language-primitives" class="contents__link">LANGUAGE PRIMITIVES</a></li><li><a href="#reserved-words" class="contents__link">RESERVED WORDS</a></li><li><a href="#feature-set" class="contents__link">FEATURE SET</a><ul><li><a href="#client-modification-feature" class="contents__link">Client Modification Feature</a></li><li><a href="#data-type-feature" class="contents__link">Data Type Feature</a></li><li><a href="#documentation-feature" class="contents__link">Documentation Feature</a></li><li><a href="#global-feature" class="contents__link">Global Feature</a></li><li><a href="#parameter-feature" class="contents__link">Parameter Feature</a></li><li><a href="#schema-support-feature" class="contents__link">Schema Support Feature</a></li><li><a href="#security-feature" class="contents__link">Security Feature</a></li><li><a href="#wire-format-feature" class="contents__link">Wire Format Feature</a></li></ul></li></ul></div></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container"><div class="row footer__links"><div class="col footer__col"><h4 class="footer__title">Docs</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/docs/customization">Customizing Generators</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation">Installation</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/integrations">Workflow Integrations</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">Community</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/users">User Showcase</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://stackoverflow.com/questions/tagged/openapi-generator">Stack Overflow</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g">Chat Room</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://twitter.com/oas_generator">Twitter</a></li></ul></div><div class="col footer__col"><h4 class="footer__title">More</h4><ul class="footer__items"><li class="footer__item"><a class="footer__link-item" href="/blog">Blog</a></li><li class="footer__item"><a class="footer__link-item" target="_blank" rel="noopener noreferrer" href="https://github.com/OpenAPITools/openapi-generator">GitHub</a></li></ul></div></div><div class="text--center"><div class="margin-bottom--sm"><a href="https://openapi-generator.tech/" target="_blank" rel="noopener noreferrer" class="footerLogoLink_1Wg7"><img class="footer__logo" alt="OpenAPI Tools" src="/img/mono-logo.svg"></a></div>Copyright © 2023 OpenAPI-Generator Contributors (https://openapi-generator.tech)</div></div></footer>
</div>
<script src="/styles.79447035.js"></script>
<script src="/runtime~main.f75f2e9d.js"></script>
<script src="/main.63d69e2d.js"></script>
<script src="/1.95ca48e7.js"></script>
<script src="/2.4c3c172b.js"></script>
<script src="/3.2018053f.js"></script>
<script src="/1be78505.feee44bb.js"></script>
<script src="/20ac7829.ee7ca853.js"></script>
<script src="/17896441.adc44f73.js"></script>
<script src="/294e02c4.23eee5af.js"></script>
</body>
</html>
View Git Blame Copy Permalink