forked from loafle/openapi-generator-original
86ead27a40
* Undefine reserved keywords Cast to correct type when applicable to be compilable on C++ compilers Add conditional instllation of configuration files * Update samples * Use default installation method if no configuration script is provided * Undefine stdin/stderr/stdout only for model files * Undefine stdin/stderr/stdout only for model files in samples * Remove #undef directives * Add stdin/stderr/stdout to reserved words for libcurl-C generator * Expose all symbols when compiling libcurl as a shared library on Windows Install header files Set correct flags for target link libraries * Remove line * Regenerate samples * Add comment * Update documentations * Revert "Update documentations" This reverts commit 0e25659de2d68753e1e033eaa83e769c028de5cb. * Update documentations * Add versioning support * Add versioning support * Add comment
275 lines
7.3 KiB
Markdown
275 lines
7.3 KiB
Markdown
---
|
|
title: Config Options for c
|
|
sidebar_label: c
|
|
---
|
|
|
|
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
|
|
|
|
| Option | Description | Values | Default |
|
|
| ------ | ----------- | ------ | ------- |
|
|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
|
|disallowAdditionalPropertiesIfNotPresent|If false, the 'additionalProperties' implementation (set to true by default) is compliant with the OAS and JSON schema specifications. If true (default), keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.|<dl><dt>**false**</dt><dd>The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications.</dd><dt>**true**</dt><dd>Keep the old (incorrect) behaviour that 'additionalProperties' is set to false by default.</dd></dl>|true|
|
|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
|
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
|
|
|legacyDiscriminatorBehavior|Set to false for generators with better support for discriminators. (Python, Java, Go, PowerShell, C#have this enabled by default).|<dl><dt>**true**</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>**false**</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>|true|
|
|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
|
|sortModelPropertiesByRequiredFlag|Sort model properties to place required parameters before optional parameters.| |true|
|
|
|sortParamsByRequiredFlag|Sort method arguments to place required parameters before optional parameters.| |true|
|
|
|
|
## IMPORT MAPPING
|
|
|
|
| Type/Alias | Imports |
|
|
| ---------- | ------- |
|
|
|
|
|
|
## INSTANTIATION TYPES
|
|
|
|
| Type/Alias | Instantiated By |
|
|
| ---------- | --------------- |
|
|
|
|
|
|
## LANGUAGE PRIMITIVES
|
|
|
|
<ul class="column-ul">
|
|
<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>
|
|
|
|
## RESERVED WORDS
|
|
|
|
<ul class="column-ul">
|
|
<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>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>char8_t</li>
|
|
<li>class</li>
|
|
<li>co_await</li>
|
|
<li>co_return</li>
|
|
<li>co_yield</li>
|
|
<li>compl</li>
|
|
<li>concept</li>
|
|
<li>const</li>
|
|
<li>const_cast</li>
|
|
<li>consteval</li>
|
|
<li>constexpr</li>
|
|
<li>constinit</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>final</li>
|
|
<li>float</li>
|
|
<li>for</li>
|
|
<li>friend</li>
|
|
<li>goto</li>
|
|
<li>if</li>
|
|
<li>inline</li>
|
|
<li>int</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>override</li>
|
|
<li>private</li>
|
|
<li>protected</li>
|
|
<li>public</li>
|
|
<li>reflexpr</li>
|
|
<li>register</li>
|
|
<li>reinterpret_cast</li>
|
|
<li>remove</li>
|
|
<li>requires</li>
|
|
<li>restrict</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>stderr</li>
|
|
<li>stdin</li>
|
|
<li>stdout</li>
|
|
<li>struct</li>
|
|
<li>switch</li>
|
|
<li>synchronized</li>
|
|
<li>template</li>
|
|
<li>this</li>
|
|
<li>thread_local</li>
|
|
<li>throw</li>
|
|
<li>transaction_safe</li>
|
|
<li>transaction_safe_dynamic</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>
|
|
|
|
## FEATURE SET
|
|
|
|
|
|
### Client Modification Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|BasePath|✗|ToolingExtension
|
|
|Authorizations|✗|ToolingExtension
|
|
|UserAgent|✗|ToolingExtension
|
|
|MockServer|✗|ToolingExtension
|
|
|
|
### Data Type Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|Custom|✗|OAS2,OAS3
|
|
|Int32|✓|OAS2,OAS3
|
|
|Int64|✓|OAS2,OAS3
|
|
|Float|✓|OAS2,OAS3
|
|
|Double|✓|OAS2,OAS3
|
|
|Decimal|✓|ToolingExtension
|
|
|String|✓|OAS2,OAS3
|
|
|Byte|✓|OAS2,OAS3
|
|
|Binary|✓|OAS2,OAS3
|
|
|Boolean|✓|OAS2,OAS3
|
|
|Date|✓|OAS2,OAS3
|
|
|DateTime|✓|OAS2,OAS3
|
|
|Password|✓|OAS2,OAS3
|
|
|File|✓|OAS2
|
|
|Array|✓|OAS2,OAS3
|
|
|Maps|✓|ToolingExtension
|
|
|CollectionFormat|✓|OAS2
|
|
|CollectionFormatMulti|✓|OAS2
|
|
|Enum|✓|OAS2,OAS3
|
|
|ArrayOfEnum|✓|ToolingExtension
|
|
|ArrayOfModel|✓|ToolingExtension
|
|
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
|
|
|ArrayOfCollectionOfModel|✓|ToolingExtension
|
|
|ArrayOfCollectionOfEnum|✓|ToolingExtension
|
|
|MapOfEnum|✓|ToolingExtension
|
|
|MapOfModel|✓|ToolingExtension
|
|
|MapOfCollectionOfPrimitives|✓|ToolingExtension
|
|
|MapOfCollectionOfModel|✓|ToolingExtension
|
|
|MapOfCollectionOfEnum|✓|ToolingExtension
|
|
|
|
### Documentation Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|Readme|✓|ToolingExtension
|
|
|Model|✓|ToolingExtension
|
|
|Api|✓|ToolingExtension
|
|
|
|
### Global Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|Host|✓|OAS2,OAS3
|
|
|BasePath|✓|OAS2,OAS3
|
|
|Info|✓|OAS2,OAS3
|
|
|Schemes|✗|OAS2,OAS3
|
|
|PartialSchemes|✓|OAS2,OAS3
|
|
|Consumes|✓|OAS2
|
|
|Produces|✓|OAS2
|
|
|ExternalDocumentation|✓|OAS2,OAS3
|
|
|Examples|✓|OAS2,OAS3
|
|
|XMLStructureDefinitions|✗|OAS2,OAS3
|
|
|MultiServer|✗|OAS3
|
|
|ParameterizedServer|✗|OAS3
|
|
|ParameterStyling|✗|OAS3
|
|
|Callbacks|✓|OAS3
|
|
|LinkObjects|✗|OAS3
|
|
|
|
### Parameter Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|Path|✓|OAS2,OAS3
|
|
|Query|✓|OAS2,OAS3
|
|
|Header|✓|OAS2,OAS3
|
|
|Body|✓|OAS2
|
|
|FormUnencoded|✓|OAS2
|
|
|FormMultipart|✓|OAS2
|
|
|Cookie|✗|OAS3
|
|
|
|
### Schema Support Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|Simple|✓|OAS2,OAS3
|
|
|Composite|✓|OAS2,OAS3
|
|
|Polymorphism|✗|OAS2,OAS3
|
|
|Union|✗|OAS3
|
|
|
|
### Security Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|BasicAuth|✓|OAS2,OAS3
|
|
|ApiKey|✓|OAS2,OAS3
|
|
|OpenIDConnect|✗|OAS3
|
|
|BearerToken|✗|OAS3
|
|
|OAuth2_Implicit|✓|OAS2,OAS3
|
|
|OAuth2_Password|✗|OAS2,OAS3
|
|
|OAuth2_ClientCredentials|✗|OAS2,OAS3
|
|
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
|
|
|
|
### Wire Format Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|JSON|✓|OAS2,OAS3
|
|
|XML|✓|OAS2,OAS3
|
|
|PROTOBUF|✗|ToolingExtension
|
|
|Custom|✗|OAS2,OAS3
|