| title |
| Documentation for the scala-finch Generator |
METADATA
| Property |
Value |
Notes |
| generator name |
scala-finch |
pass this to the generate command after -g |
| generator stability |
STABLE |
|
| generator type |
SERVER |
|
| generator language |
Scala |
|
| generator default templating engine |
mustache |
|
| helpTxt |
Generates a Scala server application with Finch. |
|
CONFIG OPTIONS
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.
| Option |
Description |
Values |
Default |
| apiPackage |
package for generated api classes |
|
null |
| modelPackage |
package for generated models |
|
null |
| packageName |
Finch package name (e.g. org.openapitools). |
|
org.openapitools |
IMPORT MAPPING
| Type/Alias |
Imports |
| ArrayBuffer |
scala.collection.mutable.ArrayBuffer |
| Date |
java.util.Date |
| DateTime |
java.time.LocalDateTime |
| File |
java.io.File |
| HashMap |
scala.collection.immutable.HashMap |
| LocalDate |
java.time.LocalDate |
| LocalDateTime |
java.time.LocalDateTime |
| LocalTime |
java.time.LocalTime |
| Map |
scala.collection.immutable.Map |
| Seq |
scala.collection.immutable.Seq |
| Timestamp |
java.sql.Timestamp |
| URI |
java.net.URI |
| UUID |
java.util.UUID |
| ZonedDateTime |
java.time.ZonedDateTime |
INSTANTIATION TYPES
| Type/Alias |
Instantiated By |
| array |
ArrayList |
| map |
HashMap |
LANGUAGE PRIMITIVES
- Any
- AnyRef
- AnyVal
- Boolean
- Double
- Float
- Int
- Integer
- Long
- Object
- String
RESERVED WORDS
- abstract
- assert
- break
- byte
- case
- catch
- char
- class
- const
- continue
- def
- default
- do
- double
- else
- enum
- extends
- false
- final
- finally
- float
- for
- forsome
- goto
- if
- implements
- implicit
- import
- instanceof
- int
- interface
- lazy
- long
- match
- native
- new
- null
- object
- override
- package
- private
- protected
- public
- return
- sealed
- short
- static
- strictfp
- super
- switch
- synchronized
- this
- throw
- throws
- trait
- transient
- true
- try
- type
- val
- var
- void
- volatile
- while
- with
- yield
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 |
| Uuid |
✗ |
|
| Array |
✓ |
OAS2,OAS3 |
| Null |
✗ |
OAS3 |
| AnyType |
✗ |
OAS2,OAS3 |
| Object |
✓ |
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 |
| allOf |
✗ |
OAS2,OAS3 |
| anyOf |
✗ |
OAS3 |
| oneOf |
✗ |
OAS3 |
| not |
✗ |
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 |
| SignatureAuth |
✗ |
OAS3 |
| AWSV4Signature |
✗ |
ToolingExtension |
Wire Format Feature
| Name |
Supported |
Defined By |
| JSON |
✓ |
OAS2,OAS3 |
| XML |
✓ |
OAS2,OAS3 |
| PROTOBUF |
✗ |
ToolingExtension |
| Custom |
✓ |
OAS2,OAS3 |
