Whether to skip the generation of models for form parameters

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SKIP_FORM_MODEL

Type Mapping is an OpenAPI Generator configuration specifying which Java types (the values) should be used for a given OAS datatype (the keys of this map)

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_TYPE_MAPPINGS__TYPE_MAPPINGS_

Import Mapping is an OpenAPI Generator configuration specifying which Java types (the values) should be imported when a given OAS datatype (the keys of this map) is used

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_IMPORT_MAPPINGS__IMPORT_MAPPINGS_

Schema Mapping is an OpenAPI Generator configuration specifying which Java types (the values) should be imported when a given schema type (the keys of this map) is used

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SCHEMA_MAPPINGS__SCHEMA_MAPPINGS_

The specified annotations will be added to the generated model files

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ADDITIONAL_MODEL_TYPE_ANNOTATIONS

Defines if the enums should have an UNEXPECTED member to convey values that cannot be parsed. Default is false.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER

The specified annotations will be added to the generated api files

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ADDITIONAL_API_TYPE_ANNOTATIONS

Add custom/additional HTTP Headers or other args to every request

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ADDITIONAL_REQUEST_ARGS

Defines if the methods should return jakarta.ws.rs.core.Response, org.jboss.resteasy.reactive.RestResponse or a model. By default, it returns the model in the specification.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_RETURN_RESPONSE

Defines if security support classes should be generated

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ENABLE_SECURITY_GENERATION

Defines the normalizer options.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_OPEN_API_NORMALIZER__NORMALIZER_

Enable SmallRye Mutiny support. If you set this to true, all return types will be wrapped in io.smallrye.mutiny.Uni.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_MUTINY

Defines with SmallRye Mutiny enabled if methods should return jakarta.ws.rs.core.Response, org.jboss.resteasy.reactive.RestResponse or a model. By default, it returns the model in the specification.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_MUTINY_RETURN_RESPONSE

Handles the return type for each operation, depending on the configuration. The following cases are supported:

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_MUTINY_OPERATION_IDS__MUTINY_MULTI_OPERATION_IDS_

Defines, whether the PartFilename (org.jboss.resteasy.reactive.PartFilename or org.jboss.resteasy.annotations.providers.multipart.PartFilename) annotation should be generated for MultipartForm POJOs. By setting to false, the annotation will not be generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_GENERATE_PART_FILENAME

Defines the filename for a part in case the PartFilename annotation (org.jboss.resteasy.reactive.PartFilename or org.jboss.resteasy.annotations.providers.multipart.PartFilename) is generated. In case no value is set, the default one is <fieldName>File or file, depending on the CommonItemConfig#useFieldNameInPartFilename configuration.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_PART_FILENAME_VALUE

Defines, whether the filename should also include the property name in case the PartFilename annotation (org.jboss.resteasy.reactive.PartFilename or org.jboss.resteasy.annotations.providers.multipart.PartFilename) is generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_USE_FIELD_NAME_IN_PART_FILENAME

Enable bean validation. If you set this to true, validation annotations are added to generated sources E.g. @Size.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_USE_BEAN_VALIDATION

Enable the generation of APIs. If you set this to false, APIs will not be generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_GENERATE_APIS

Whether or not the @org.eclipse.microprofile.rest.client.inject.RegisterRestClient annotation should be present on an API class. Defaults to true.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_REGISTER_REST_CLIENT

Which CDI scope annotation (if any) should be placed on the generated API. Defaults to @jakarta.enterprise.context.ApplicationScoped.

You can also set to the value none to not have a scope annotation at all.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_API_CDI_SCOPE

Enable the generation of models. If you set this to false, models will not be generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_GENERATE_MODELS

Enable the generation of equals and hashcode in models. If you set this to false, the models will not have equals and hashcode.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_EQUALS_HASHCODE

Add additional properties as attribute.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ADDITIONAL_PROPERTIES_AS_ATTRIBUTE

Initialise collections as empty instead of null

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_INITIALIZE_EMPTY_COLLECTIONS

Whether to log the internal generator codegen process in the default output or not.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_VERBOSE

Option to change the directory where OpenAPI files must be found.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_INPUT_BASE_DIR

Whether or not to skip gav scanning.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_GAV_SCANNING

Option to change the directory where template files must be found.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_TEMPLATE_BASE_DIR

Whether or not to skip validating the input spec prior to generation. By default, invalid specifications will result in an error.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_VALIDATESPEC

Option to specify files for which generation should be executed only

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_INCLUDE

Option to exclude file from generation

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_EXCLUDE

Option to filter artifactId from generation

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_ARTIFACT_ID_FILTER

Option to exclude GAVs from generation

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_EXCLUDE_GAVS

Option to specify GAVs for which generation should be executed only. Depending on the GAV Provider default behavior differs:

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_INCLUDE_GAVS

Create security for the referenced security scheme

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_DEFAULT_SECURITY_SCHEME

Whether to skip the generation of models for form parameters

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__SKIP_FORM_MODEL

Type Mapping is an OpenAPI Generator configuration specifying which Java types (the values) should be used for a given OAS datatype (the keys of this map)

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__TYPE_MAPPINGS__TYPE_MAPPINGS_

Import Mapping is an OpenAPI Generator configuration specifying which Java types (the values) should be imported when a given OAS datatype (the keys of this map) is used

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__IMPORT_MAPPINGS__IMPORT_MAPPINGS_

Schema Mapping is an OpenAPI Generator configuration specifying which Java types (the values) should be imported when a given schema type (the keys of this map) is used

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__SCHEMA_MAPPINGS__SCHEMA_MAPPINGS_

The specified annotations will be added to the generated model files

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__ADDITIONAL_MODEL_TYPE_ANNOTATIONS

Defines if the enums should have an UNEXPECTED member to convey values that cannot be parsed. Default is false.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__ADDITIONAL_ENUM_TYPE_UNEXPECTED_MEMBER

The specified annotations will be added to the generated api files

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__ADDITIONAL_API_TYPE_ANNOTATIONS

Add custom/additional HTTP Headers or other args to every request

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__ADDITIONAL_REQUEST_ARGS

Defines if the methods should return jakarta.ws.rs.core.Response, org.jboss.resteasy.reactive.RestResponse or a model. By default, it returns the model in the specification.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__RETURN_RESPONSE

Defines if security support classes should be generated

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__ENABLE_SECURITY_GENERATION

Defines the normalizer options.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__OPEN_API_NORMALIZER__NORMALIZER_

Enable SmallRye Mutiny support. If you set this to true, all return types will be wrapped in io.smallrye.mutiny.Uni.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__MUTINY

Defines with SmallRye Mutiny enabled if methods should return jakarta.ws.rs.core.Response, org.jboss.resteasy.reactive.RestResponse or a model. By default, it returns the model in the specification.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__MUTINY_RETURN_RESPONSE

Handles the return type for each operation, depending on the configuration. The following cases are supported:

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__MUTINY_OPERATION_IDS__MUTINY_MULTI_OPERATION_IDS_

Defines, whether the PartFilename (org.jboss.resteasy.reactive.PartFilename or org.jboss.resteasy.annotations.providers.multipart.PartFilename) annotation should be generated for MultipartForm POJOs. By setting to false, the annotation will not be generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__GENERATE_PART_FILENAME

Defines the filename for a part in case the PartFilename annotation (org.jboss.resteasy.reactive.PartFilename or org.jboss.resteasy.annotations.providers.multipart.PartFilename) is generated. In case no value is set, the default one is <fieldName>File or file, depending on the CommonItemConfig#useFieldNameInPartFilename configuration.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__PART_FILENAME_VALUE

Defines, whether the filename should also include the property name in case the PartFilename annotation (org.jboss.resteasy.reactive.PartFilename or org.jboss.resteasy.annotations.providers.multipart.PartFilename) is generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__USE_FIELD_NAME_IN_PART_FILENAME

Enable bean validation. If you set this to true, validation annotations are added to generated sources E.g. @Size.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__USE_BEAN_VALIDATION

Enable the generation of APIs. If you set this to false, APIs will not be generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__GENERATE_APIS

Whether or not the @org.eclipse.microprofile.rest.client.inject.RegisterRestClient annotation should be present on an API class. Defaults to true.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__REGISTER_REST_CLIENT

Which CDI scope annotation (if any) should be placed on the generated API. Defaults to @jakarta.enterprise.context.ApplicationScoped.

You can also set to the value none to not have a scope annotation at all.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__API_CDI_SCOPE

Enable the generation of models. If you set this to false, models will not be generated.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__GENERATE_MODELS

Enable the generation of equals and hashcode in models. If you set this to false, the models will not have equals and hashcode.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__EQUALS_HASHCODE

Add additional properties as attribute.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__ADDITIONAL_PROPERTIES_AS_ATTRIBUTE

Initialise collections as empty instead of null

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__INITIALIZE_EMPTY_COLLECTIONS

Base package for where the generated code for the given OpenAPI specification will be added.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__BASE_PACKAGE

Custom config key to use in place of the openapi spec file

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__CONFIG_KEY

Suffix name for generated api classes

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__API_NAME_SUFFIX

Suffix name for generated model classes

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__MODEL_NAME_SUFFIX

Prefix name for generated model classes

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__MODEL_NAME_PREFIX

Remove operation id prefix

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__REMOVE_OPERATION_ID_PREFIX

Remove operation id prefix

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__REMOVE_OPERATION_ID_PREFIX_DELIMITER

Remove operation id prefix

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__REMOVE_OPERATION_ID_PREFIX_COUNT

Set serializable model

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__SERIALIZABLE_MODEL

Whether to enable Dynamic URLs on APIs methods. By enabling this property every method on RestClients will be annotated with io.quarkus.rest.client.reactive.Url.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__USE_DYNAMIC_URL

Whether to generate model classes that can be used as Bean Param in REST endpoints.

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_SPEC__SPEC_ITEM__GENERATE_MODEL_FOR_USAGE_AS_BEAN_PARAM

List of OpenAPI spec files in GAV to be generated

Environment variable: QUARKUS_OPENAPI_GENERATOR_CODEGEN_GAV__GAV_ITEM__SPEC_FILES

Enables the authentication token propagation for this particular securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-auth" the following configuration must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_auth.token-propagation=true

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__TOKEN_PROPAGATION

Configures a particular http header attribute from were to take the security token from when the token propagation is enabled. Use this fine-grained configuration in very particular scenarios.

For example, given a file named petstore.json with a securityScheme named "petstore-auth" the following configuration must be used.

quarkus.openapi-generator.petstore_json.auth.petstore_auth.header-name=MyParticularHttpHeaderName

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__HEADER_NAME

Sets the Basic Authentication username for a given OpenAPI securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-basic-auth", that is of http basic authentication type, the following configuration can establish the user to be used.

quarkus.openapi-generator.petstore_json.auth.petstore_basic_auth.username=MyUserName

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__USERNAME

Sets the Basic Authentication password for a given OpenAPI securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-basic-auth", that is of http basic authentication type, the following configuration can establish the password to be used.

quarkus.openapi-generator.petstore_json.auth.petstore_basic_auth.password=MyPassword

Ignored if the given securityScheme is not Basic Authentication

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__PASSWORD

Sets the Bearer Token for a given OpenAPI securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-bearer-auth", that is of bearer authentication type, the following configuration can establish the token to be used.

quarkus.openapi-generator.petstore_json.auth.petstore_bearer_auth.token=1234567890

Ignored if the given securityScheme is not Bearer Token Authentication

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__BEARER_TOKEN

Sets the API Key for a given OpenAPI securityScheme.

For example, given a file named petstore.json with a securityScheme named "petstore-apikey-auth", that is of API Key authentication type, the following configuration can establish the API Key to be used.

quarkus.openapi-generator.petstore_json.auth.petstore_apikey_auth.api-key=${MY_SECRET_KEY_IN_AN_ENV_VAR}

Ignored if the given securityScheme is not API Key Authentication

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__API_KEY

Only valid for API Key Authentication.

When to add the Authorization value to the API Key in the authentication header.

For example, if this property is set to true, the API Key will be sent to the server in the header along with Authorization:

[source] --- Authentication: Authorization MY-API-KEY ---

If set to false, the header should be:

[source] --- Authentication: MY-API-KEY ---

Environment variable: QUARKUS_OPENAPI_GENERATOR__ITEM_CONFIGS__AUTH__AUTH_CONFIGS__USE_AUTHORIZATION_HEADER_VALUE