2019-08-22 08:06:04 +00:00
|
|
|
---
|
|
|
|
title: Config Options for avro-schema
|
|
|
|
sidebar_label: avro-schema
|
|
|
|
---
|
|
|
|
|
|
|
|
| Option | Description | Values | Default |
|
|
|
|
| ------ | ----------- | ------ | ------- |
|
|
|
|
|allowUnicodeIdentifiers|boolean, toggles whether unicode identifiers are allowed in names or not, default is false| |false|
|
2020-01-20 01:19:11 +00:00
|
|
|
|ensureUniqueParams|Whether to ensure parameter names are unique in an operation (rename parameters that are not).| |true|
|
2019-08-22 08:06:04 +00:00
|
|
|
|packageName|package for generated classes (where supported)| |null|
|
2020-01-20 01:19:11 +00:00
|
|
|
|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|Array|
|
|
|
|
|list|Array|
|
|
|
|
|map|Object|
|
|
|
|
|
|
|
|
|
|
|
|
## LANGUAGE PRIMITIVES
|
|
|
|
|
2020-02-11 13:22:58 +00:00
|
|
|
<ul class="column-ul">
|
|
|
|
<li>BigDecimal</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>DateTime</li>
|
|
|
|
<li>UUID</li>
|
|
|
|
<li>boolean</li>
|
|
|
|
<li>bytes</li>
|
|
|
|
<li>date</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>double</li>
|
|
|
|
<li>float</li>
|
|
|
|
<li>int</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>integer</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>long</li>
|
|
|
|
<li>null</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>number</li>
|
|
|
|
<li>string</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
</ul>
|
|
|
|
|
|
|
|
## RESERVED WORDS
|
|
|
|
|
2020-02-11 13:22:58 +00:00
|
|
|
<ul class="column-ul">
|
|
|
|
</ul>
|
2020-02-02 01:51:55 +00:00
|
|
|
|
|
|
|
## 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
|