mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-19 08:00:54 +00:00
248 lines
6.3 KiB
Markdown
248 lines
6.3 KiB
Markdown
---
|
|
title: Config Options for javascript-apollo
|
|
sidebar_label: javascript-apollo
|
|
---
|
|
|
|
| Option | Description | Values | Default |
|
|
| ------ | ----------- | ------ | ------- |
|
|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
|
|enumNameSuffix|Suffix that will be appended to all enum names. A special 'v4-compat' value enables the backward-compatible behavior (as pre v4.2.3)| |v4-compat|
|
|
|enumPropertyNaming|Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original'| |PascalCase|
|
|
|modelPropertyNaming|Naming convention for the property: 'camelCase', 'PascalCase', 'snake_case' and 'original', which keeps the original name. Only change it if you provide your own run-time code for (de-)serialization of models| |original|
|
|
|npmName|The name under which you want to publish generated npm package. Required to generate a full package| |null|
|
|
|npmRepository|Use this property to set an url your private npmRepo in the package.json| |null|
|
|
|npmVersion|The version of your npm package. If not provided, using the version from the OpenAPI specification file.| |1.0.0|
|
|
|nullSafeAdditionalProps|Set to make additional properties types declare that their indexer may return undefined| |false|
|
|
|prependFormOrBodyParameters|Add form or body parameters to the beginning of the parameter list.| |false|
|
|
|snapshot|When setting this property to true, the version will be suffixed with -SNAPSHOT.yyyyMMddHHmm| |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 |
|
|
| ---------- | --------------- |
|
|
|array|Array|
|
|
|list|Array|
|
|
|map|Object|
|
|
|
|
|
|
## LANGUAGE PRIMITIVES
|
|
|
|
<ul class="column-ul">
|
|
<li>Array</li>
|
|
<li>Blob</li>
|
|
<li>Date</li>
|
|
<li>File</li>
|
|
<li>Object</li>
|
|
<li>boolean</li>
|
|
<li>number</li>
|
|
<li>string</li>
|
|
</ul>
|
|
|
|
## RESERVED WORDS
|
|
|
|
<ul class="column-ul">
|
|
<li>abstract</li>
|
|
<li>arguments</li>
|
|
<li>array</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>date</li>
|
|
<li>debugger</li>
|
|
<li>default</li>
|
|
<li>delete</li>
|
|
<li>do</li>
|
|
<li>double</li>
|
|
<li>else</li>
|
|
<li>enum</li>
|
|
<li>eval</li>
|
|
<li>export</li>
|
|
<li>extends</li>
|
|
<li>false</li>
|
|
<li>final</li>
|
|
<li>finally</li>
|
|
<li>float</li>
|
|
<li>for</li>
|
|
<li>formparams</li>
|
|
<li>function</li>
|
|
<li>goto</li>
|
|
<li>hasownproperty</li>
|
|
<li>headerparams</li>
|
|
<li>if</li>
|
|
<li>implements</li>
|
|
<li>import</li>
|
|
<li>in</li>
|
|
<li>infinity</li>
|
|
<li>instanceof</li>
|
|
<li>int</li>
|
|
<li>interface</li>
|
|
<li>isfinite</li>
|
|
<li>isnan</li>
|
|
<li>isprototypeof</li>
|
|
<li>let</li>
|
|
<li>long</li>
|
|
<li>math</li>
|
|
<li>nan</li>
|
|
<li>native</li>
|
|
<li>new</li>
|
|
<li>null</li>
|
|
<li>number</li>
|
|
<li>object</li>
|
|
<li>package</li>
|
|
<li>private</li>
|
|
<li>protected</li>
|
|
<li>prototype</li>
|
|
<li>public</li>
|
|
<li>queryparameters</li>
|
|
<li>requestoptions</li>
|
|
<li>return</li>
|
|
<li>short</li>
|
|
<li>static</li>
|
|
<li>string</li>
|
|
<li>super</li>
|
|
<li>switch</li>
|
|
<li>synchronized</li>
|
|
<li>this</li>
|
|
<li>throw</li>
|
|
<li>throws</li>
|
|
<li>tostring</li>
|
|
<li>transient</li>
|
|
<li>true</li>
|
|
<li>try</li>
|
|
<li>typeof</li>
|
|
<li>undefined</li>
|
|
<li>useformdata</li>
|
|
<li>valueof</li>
|
|
<li>var</li>
|
|
<li>varlocaldeferred</li>
|
|
<li>varlocalpath</li>
|
|
<li>void</li>
|
|
<li>volatile</li>
|
|
<li>while</li>
|
|
<li>with</li>
|
|
<li>yield</li>
|
|
</ul>
|
|
|
|
## FEATURE SET
|
|
|
|
|
|
### Client Modification Feature
|
|
| Name | Supported | Defined By |
|
|
| ---- | --------- | ---------- |
|
|
|BasePath|✓|ToolingExtension
|
|
|Authorizations|✗|ToolingExtension
|
|
|UserAgent|✗|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
|