Package io.quarkiverse.openapi.generator.deployment

Interface CommonItemConfig

All Known Subinterfaces:
CodegenConfig, GlobalCodegenConfig, SpecItemConfig
public interface CommonItemConfig

  • Method Details

    • skipFormModel

      @WithName("skip-form-model") Optional<Boolean> skipFormModel()
      Whether to skip the generation of models for form parameters

    • typeMappings

      @WithName("type-mappings") Map<String,String> typeMappings()
      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)

    • importMappings

      @WithName("import-mappings") Map<String,String> importMappings()
      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

    • schemaMappings

      @WithName("schema-mappings") Map<String,String> schemaMappings()
      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

    • additionalModelTypeAnnotations

      @WithName("additional-model-type-annotations") Optional<String> additionalModelTypeAnnotations()
      The specified annotations will be added to the generated model files

    • additionalEnumTypeUnexpectedMemberAnnotations

      @WithName("additional-enum-type-unexpected-member") Optional<Boolean> additionalEnumTypeUnexpectedMemberAnnotations()
      Defines if the enums should have an `UNEXPECTED` member to convey values that cannot be parsed. Default is false.

    • additionalApiTypeAnnotations

      @WithName("additional-api-type-annotations") Optional<String> additionalApiTypeAnnotations()
      The specified annotations will be added to the generated api files

    • additionalRequestArgs

      @WithName("additional-request-args") Optional<String> additionalRequestArgs()
      Add custom/additional HTTP Headers or other args to every request

    • returnResponse

      @WithName("return-response") Optional<Boolean> returnResponse()
      Defines if the methods should return jakarta.ws.rs.core.Response or a model. Default is false.

    • enableSecurityGeneration

      @WithName("enable-security-generation") Optional<String> enableSecurityGeneration()
      Defines if security support classes should be generated

    • normalizer

      @WithName("open-api-normalizer") Map<String,String> normalizer()
      Defines the normalizer options.

    • supportMutiny

      @WithName("mutiny") Optional<Boolean> supportMutiny()
      Enable SmallRye Mutiny support. If you set this to true, all return types will be wrapped in Uni.

    • mutinyReturnResponse

      @WithName("mutiny.return-response") Optional<Boolean> mutinyReturnResponse()
      Defines with SmallRye Mutiny enabled if methods should return jakarta.ws.rs.core.Response or a model. Default is false.

    • mutinyMultiOperationIds

      @WithName("mutiny.operation-ids") Map<String,String> mutinyMultiOperationIds()
      Handles the return type for each operation, depending on the configuration. The following cases are supported:

      1. If mutiny is enabled and the operation ID is specified to return Multi: - The return type will be wrapped in Multi. - If mutiny.return-response is enabled, the return type will be io.smallrye.mutiny.Multi<jakarta.ws.rs.core.Response>. - If the operation has a void return type, it will return io.smallrye.mutiny.Multi<jakarta.ws.rs.core.Response>. - Otherwise, it will return io.smallrye.mutiny.Multi<returnType>.

      2. If mutiny is enabled and the operation ID is specified to return Uni: - The return type will be wrapped in Uni. - If mutiny.return-response is enabled, the return type will be io.smallrye.mutiny.Uni<jakarta.ws.rs.core.Response>. - If the operation has a void return type, it will return io.smallrye.mutiny.Uni<jakarta.ws.rs.core.Response>. - Otherwise, it will return io.smallrye.mutiny.Uni<returnType>.

      3. If mutiny is enabled but no specific operation ID is configured for Multi or Uni: - The return type defaults to Uni. - If mutiny.return-response is enabled, the return type will be io.smallrye.mutiny.Uni<jakarta.ws.rs.core.Response>. - If the operation has a void return type, it will return io.smallrye.mutiny.Uni<jakarta.ws.rs.core.Response>. - Otherwise, it will return io.smallrye.mutiny.Uni<returnType>`.

    • generatePartFilename

      @WithName("generate-part-filename") Optional<Boolean> generatePartFilename()
      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.

    • partFilenameValue

      @WithName("part-filename-value") Optional<String> partFilenameValue()
      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 useFieldNameInPartFilename() configuration.

    • useFieldNameInPartFilename

      @WithName("use-field-name-in-part-filename") Optional<Boolean> useFieldNameInPartFilename()
      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.

    • useBeanValidation

      @WithName("use-bean-validation") Optional<Boolean> useBeanValidation()
      Enable bean validation. If you set this to true, validation annotations are added to generated sources E.g. @Size.

    • generateApis

      @WithName("generate-apis") Optional<Boolean> generateApis()
      Enable the generation of APIs. If you set this to false, APIs will not be generated.

    • generateModels

      @WithName("generate-models") Optional<Boolean> generateModels()
      Enable the generation of models. If you set this to false, models will not be generated.

    • equalsHashcode

      @WithName("equals-hashcode") Optional<Boolean> equalsHashcode()
      Enable the generation of equals and hashcode in models. If you set this to false, the models will not have equals and hashcode.