2019-01-18 09:39:33 +00:00
|
|
|
---
|
|
|
|
title: Config Options for erlang-server
|
|
|
|
sidebar_label: erlang-server
|
|
|
|
---
|
|
|
|
|
|
|
|
| Option | Description | Values | Default |
|
|
|
|
| ------ | ----------- | ------ | ------- |
|
|
|
|
|openAPISpecName|Openapi Spec Name.| |openapi|
|
2020-01-20 01:19:11 +00:00
|
|
|
|packageName|Erlang package name (convention: lowercase).| |openapi|
|
2020-01-09 02:54:05 +00:00
|
|
|
|
|
|
|
## IMPORT MAPPING
|
|
|
|
|
|
|
|
| Type/Alias | Imports |
|
|
|
|
| ---------- | ------- |
|
2020-01-20 01:19:11 +00:00
|
|
|
|Array|java.util.List|
|
2020-01-09 02:54:05 +00:00
|
|
|
|ArrayList|java.util.ArrayList|
|
|
|
|
|BigDecimal|java.math.BigDecimal|
|
|
|
|
|Date|java.util.Date|
|
|
|
|
|DateTime|org.joda.time.*|
|
|
|
|
|File|java.io.File|
|
2020-01-20 01:19:11 +00:00
|
|
|
|HashMap|java.util.HashMap|
|
|
|
|
|List|java.util.*|
|
|
|
|
|LocalDate|org.joda.time.*|
|
|
|
|
|LocalDateTime|org.joda.time.*|
|
|
|
|
|LocalTime|org.joda.time.*|
|
2020-01-09 02:54:05 +00:00
|
|
|
|Map|java.util.Map|
|
2020-01-20 01:19:11 +00:00
|
|
|
|Set|java.util.*|
|
|
|
|
|Timestamp|java.sql.Timestamp|
|
|
|
|
|URI|java.net.URI|
|
|
|
|
|UUID|java.util.UUID|
|
2020-01-09 02:54:05 +00:00
|
|
|
|
|
|
|
|
|
|
|
## INSTANTIATION TYPES
|
|
|
|
|
|
|
|
| Type/Alias | Instantiated By |
|
|
|
|
| ---------- | --------------- |
|
|
|
|
|
|
|
|
|
|
|
|
## 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"></ul>
|
|
|
|
|
|
|
|
## RESERVED WORDS
|
|
|
|
|
2020-01-20 01:19:11 +00:00
|
|
|
<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>after</li>
|
|
|
|
<li>and</li>
|
|
|
|
<li>andalso</li>
|
|
|
|
<li>band</li>
|
|
|
|
<li>begin</li>
|
|
|
|
<li>bnot</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>bor</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>bsl</li>
|
|
|
|
<li>bsr</li>
|
|
|
|
<li>bxor</li>
|
|
|
|
<li>case</li>
|
|
|
|
<li>catch</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>cond</li>
|
|
|
|
<li>div</li>
|
|
|
|
<li>end</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>fun</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>if</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>let</li>
|
|
|
|
<li>not</li>
|
|
|
|
<li>of</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>or</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>orelse</li>
|
|
|
|
<li>receive</li>
|
|
|
|
<li>rem</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
<li>try</li>
|
2020-01-20 01:19:11 +00:00
|
|
|
<li>when</li>
|
|
|
|
<li>xor</li>
|
2020-01-09 02:54:05 +00:00
|
|
|
</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
|