openapi-generator/docs/generators/apex.md

295 lines
6.5 KiB
Markdown
Raw Normal View History

---
title: Config Options for apex
sidebar_label: apex
---
| Option | Description | Values | Default |
| ------ | ----------- | ------ | ------- |
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|apiVersion|The Metadata API version number to use for components in this package.| |null|
|buildMethod|The build method for this package.| |null|
|classPrefix|Prefix for generated classes. Set this to avoid overwriting existing classes in your org.| |null|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|namedCredential|The named credential name for the HTTP callouts| |null|
|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|
2020-01-09 02:54:05 +00:00
## IMPORT MAPPING
| Type/Alias | Imports |
| ---------- | ------- |
## INSTANTIATION TYPES
| Type/Alias | Instantiated By |
| ---------- | --------------- |
|array|List|
|map|Map|
## LANGUAGE PRIMITIVES
<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>
2020-01-09 02:54:05 +00:00
<li>Date</li>
<li>Datetime</li>
2020-01-09 02:54:05 +00:00
<li>Decimal</li>
<li>Double</li>
<li>ID</li>
<li>Integer</li>
2020-01-09 02:54:05 +00:00
<li>Long</li>
<li>Object</li>
<li>String</li>
<li>Time</li>
2020-01-09 02:54:05 +00:00
</ul>
## RESERVED WORDS
<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>
2020-01-09 02:54:05 +00:00
<li>as</li>
<li>asc</li>
<li>autonomous</li>
2020-01-09 02:54:05 +00:00
<li>begin</li>
<li>bigdecimal</li>
<li>blob</li>
2020-01-09 02:54:05 +00:00
<li>break</li>
<li>bulk</li>
<li>by</li>
<li>byte</li>
<li>case</li>
<li>cast</li>
<li>catch</li>
2020-01-09 02:54:05 +00:00
<li>char</li>
<li>class</li>
<li>collect</li>
<li>commit</li>
<li>const</li>
<li>continue</li>
<li>convertcurrency</li>
<li>currency</li>
2020-01-09 02:54:05 +00:00
<li>date</li>
<li>datetime</li>
<li>decimal</li>
<li>default</li>
<li>delete</li>
<li>desc</li>
2020-01-09 02:54:05 +00:00
<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>
2020-01-09 02:54:05 +00:00
<li>float</li>
<li>for</li>
2020-01-09 02:54:05 +00:00
<li>from</li>
<li>future</li>
<li>global</li>
<li>goto</li>
2020-01-09 02:54:05 +00:00
<li>group</li>
<li>having</li>
2020-01-09 02:54:05 +00:00
<li>hint</li>
<li>if</li>
2020-01-09 02:54:05 +00:00
<li>implements</li>
<li>import</li>
<li>in</li>
<li>inner</li>
2020-01-09 02:54:05 +00:00
<li>insert</li>
<li>instanceof</li>
<li>int</li>
2020-01-09 02:54:05 +00:00
<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>
2020-01-09 02:54:05 +00:00
<li>not</li>
<li>null</li>
<li>nulls</li>
<li>number</li>
<li>object</li>
2020-01-09 02:54:05 +00:00
<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>
2020-01-09 02:54:05 +00:00
<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>
2020-01-09 02:54:05 +00:00
<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>
2020-01-09 02:54:05 +00:00
</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