# Config Options for java-pkmst

Option | Description | Values | Default
--- | --- | --- | ---
additionalModelTypeAnnotations | Additional annotations for model type(class level annotations) |  | null
allowUnicodeIdentifiers | boolean, toggles whether unicode identifiers are allowed in names or not, default is false |  | false
apiPackage | package for generated api classes |  | com.prokarma.pkmst.controller
artifactDescription | artifact description in generated pom.xml |  | OpenAPI Java
artifactId | artifactId in generated pom.xml. This also becomes part of the generated library's filename |  | pkmst-microservice
artifactUrl | artifact URL in generated pom.xml |  | https://github.com/openapitools/openapi-generator
artifactVersion | artifact version in generated pom.xml. This also becomes part of the generated library's filename |  | 1.0.0
basePackage | base package for java source code |  | null
bigDecimalAsString | Treat BigDecimal values as Strings to avoid precision loss. |  | false
booleanGetterPrefix | Set booleanGetterPrefix |  | get
dateLibrary | Option. Date library to use | joda Joda (for legacy app only) legacy Legacy java.util.Date (if you really have a good reason not to use threetenbp java8-localdatetime Java 8 using LocalDateTime (for legacy app only) java8 Java 8 native JSR310 (preferred for jdk 1.8+) - note: this also sets "java8" to true threetenbp Backport of JSR310 (preferred for jdk < 1.8) | threetenbp
developerEmail | developer email in generated pom.xml |  | team@openapitools.org
developerName | developer name in generated pom.xml |  | OpenAPI-Generator Contributors
developerOrganization | developer organization in generated pom.xml |  | OpenAPITools.org
developerOrganizationUrl | developer organization URL in generated pom.xml |  | http://openapitools.org
disableHtmlEscaping | Disable HTML escaping of JSON strings when using gson (needed to avoid problems with byte[] fields) |  | false
disallowAdditionalPropertiesIfNotPresent | Specify the behavior when the 'additionalProperties' keyword is not present in the OAS document. If false: the 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. If true: when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior.This setting is currently ignored for OAS 2.0 documents: 1) When the 'additionalProperties' keyword is not present in a 2.0 schema, additional properties are NOT allowed. 2) Boolean values of the 'additionalProperties' keyword are ignored. It's as if additional properties are NOT allowed.Note: the root cause are issues #1369 and #1371, which must be resolved in the swagger-parser project. | false The 'additionalProperties' implementation is compliant with the OAS and JSON schema specifications. true when the 'additionalProperties' keyword is not present in a schema, the value of 'additionalProperties' is automatically set to false, i.e. no additional properties are allowed. Note: this mode is not compliant with the JSON schema specification. This is the original openapi-generator behavior. | true
discriminatorCaseSensitive | Whether the discriminator value lookup should be case-sensitive or not. This option only works for Java API client |  | true
ensureUniqueParams | Whether to ensure parameter names are unique in an operation (rename parameters that are not). |  | true
eurekaUri | Eureka URI |  | null
fullJavaUtil | whether to use fully qualified name for classes under java.util. This option only works for Java API client |  | false
groupId | groupId in generated pom.xml |  | com.prokarma
hideGenerationTimestamp | Hides the generation timestamp when files are generated. |  | false
ignoreAnyOfInEnum | Ignore anyOf keyword in enum |  | false
invokerPackage | root package for generated code |  | com.prokarma.pkmst.controller
java8 | Use Java8 classes instead of third party equivalents. Starting in 5.x, JDK8 is the default and the support for JDK7, JDK6 has been dropped | true Use Java 8 classes such as Base64 false Various third party libraries as needed | true
legacyDiscriminatorBehavior | This flag is used by OpenAPITools codegen to influence the processing of the discriminator attribute in OpenAPI documents. This flag has no impact if the OAS document does not use the discriminator attribute. The default value of this flag is set in each language-specific code generator (e.g. Python, Java, go...)using the method toModelName. Note to developers supporting a language generator in OpenAPITools; to fully support the discriminator attribute as defined in the OAS specification 3.x, language generators should set this flag to true by default; however this requires updating the mustache templates to generate a language-specific discriminator lookup function that iterates over {{#mappedModels}} and does not iterate over {{children}}, {{#anyOf}}, or {{#oneOf}}. | true The mapping in the discriminator includes descendent schemas that allOf inherit from self and the discriminator mapping schemas in the OAS document. false The mapping in the discriminator includes any descendent schemas that allOf inherit from self, any oneOf schemas, any anyOf schemas, any x-discriminator-values, and the discriminator mapping schemas in the OAS document AND Codegen validates that oneOf and anyOf schemas contain the required discriminator and throws an error if the discriminator is missing. | true
licenseName | The name of the license |  | Unlicense
licenseUrl | The URL of the license |  | http://unlicense.org
modelPackage | package for generated models |  | com.prokarma.pkmst.model
openApiNullable | Enable OpenAPI Jackson Nullable library |  | true
parentArtifactId | parent artifactId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect |  | null
parentGroupId | parent groupId in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect |  | null
parentVersion | parent version in generated pom N.B. parentGroupId, parentArtifactId and parentVersion must all be specified for any of them to take effect |  | null
pkmstInterceptor | PKMST Interceptor |  | null
prependFormOrBodyParameters | Add form or body parameters to the beginning of the parameter list. |  | false
scmConnection | SCM connection in generated pom.xml |  | scm:git:git@github.com:openapitools/openapi-generator.git
scmDeveloperConnection | SCM developer connection in generated pom.xml |  | scm:git:git@github.com:openapitools/openapi-generator.git
scmUrl | SCM URL in generated pom.xml |  | https://github.com/openapitools/openapi-generator
serializableModel | boolean - toggle "implements Serializable" for generated models |  | false
serviceName | Service Name |  | null
snapshotVersion | Uses a SNAPSHOT version. | true Use a SnapShot Version false Use a Release Version | null
sortModelPropertiesByRequiredFlag | Sort model properties to place required parameters before optional parameters. |  | true
sortParamsByRequiredFlag | Sort method arguments to place required parameters before optional parameters. |  | true
sourceFolder | source folder for generated code |  | src/main/java
springBootAdminUri | Spring-Boot URI |  | null
title | server title name or client service name |  | null
withXml | whether to include support for application/xml content type and include XML annotations in the model (works with libraries that provide support for JSON and XML) |  | false
zipkinUri | Zipkin URI |  | null

## #IMPORT MAPPING

Type/Alias | Imports
--- | ---
Array | java.util.List
ArrayList | java.util.ArrayList
BigDecimal | java.math.BigDecimal
Date | java.util.Date
DateTime | org.joda.time.*
File | java.io.File
HashMap | java.util.HashMap
LinkedHashSet | java.util.LinkedHashSet
List | java.util.*
LocalDate | org.joda.time.*
LocalDateTime | org.joda.time.*
LocalTime | org.joda.time.*
Map | java.util.Map
Set | java.util.*
Timestamp | java.sql.Timestamp
URI | java.net.URI
UUID | java.util.UUID

## #INSTANTIATION TYPES

Type/Alias | Instantiated By
--- | ---
array | ArrayList
map | HashMap
set | LinkedHashSet

## #LANGUAGE PRIMITIVES

- Boolean
- Double
- Float
- Integer
- Long
- Object
- String
- boolean
- byte[]

## #RESERVED WORDS

- abstract
- apiclient
- apiexception
- apiresponse
- assert
- boolean
- break
- byte
- case
- catch
- char
- class
- configuration
- const
- continue
- default
- do
- double
- else
- enum
- extends
- final
- finally
- float
- for
- goto
- if
- implements
- import
- instanceof
- int
- interface
- localreturntype
- localvaraccept
- localvaraccepts
- localvarauthnames
- localvarcollectionqueryparams
- localvarcontenttype
- localvarcontenttypes
- localvarcookieparams
- localvarformparams
- localvarheaderparams
- localvarpath
- localvarpostbody
- localvarqueryparams
- long
- native
- new
- null
- object
- package
- private
- protected
- public
- return
- short
- static
- strictfp
- stringutil
- super
- switch
- synchronized
- this
- throw
- throws
- transient
- try
- void
- volatile
- while

## #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
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

Edit this page
Last updated on 2020-9-14 by spacether

- IMPORT MAPPING
- INSTANTIATION TYPES
- LANGUAGE PRIMITIVES
- RESERVED WORDS
- FEATURE SET
  - Client Modification Feature
  - Data Type Feature
  - Documentation Feature
  - Global Feature
  - Parameter Feature
  - Schema Support Feature
  - Security Feature
  - Wire Format Feature