Micronaut openapi 6.13.0

micronaut-projects · Oct 22, 2024 · cbadcf7 · cbadcf7
1 parent 9d7f22f
commit cbadcf7
Show file tree

Hide file tree

Showing 6 changed files with 201 additions and 9 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -14,10 +14,10 @@ log4j2 = "2.24.1"
 jetbrains-annotations = "26.0.1"
 tomlj = "1.1.1"
 
-micronaut-platform = "4.6.0" # This is the platform version, used in our tests
+micronaut-platform = "4.6.3" # This is the platform version, used in our tests
 micronaut-aot = "2.5.0"
 micronaut-testresources = "2.6.2"
-micronaut-openapi = "6.12.2"
+micronaut-openapi = "6.13.0"
 
 [libraries]
 # Core

diff --git a/openapi-plugin/src/main/java/io/micronaut/gradle/openapi/DefaultOpenApiExtension.java b/openapi-plugin/src/main/java/io/micronaut/gradle/openapi/DefaultOpenApiExtension.java
@@ -126,6 +126,26 @@ private void configureCommonExtensionDefaults(OpenApiSpec spec) {
         spec.getGenerateHttpResponseWhereRequired().convention(false);
         spec.getDateTimeFormat().convention("ZONED_DATETIME");
         spec.getLang().convention("java");
+        spec.getGenerateSwaggerAnnotations().convention(false);
+        spec.getApiNamePrefix().convention("");
+        spec.getApiNameSuffix().convention("");
+        spec.getModelNamePrefix().convention("");
+        spec.getModelNameSuffix().convention("");
+        spec.getImplicitHeaders().convention(false);
+        spec.getImplicitHeadersRegex().convention("");
+        spec.getUseEnumCaseInsensitive().convention(false);
+
+        spec.getUseJakartaEe().convention(true);
+        spec.getSortParamsByRequiredFlag().convention(true);
+        spec.getSkipOperationExample().convention(false);
+        spec.getSkipSortingOperations().convention(false);
+        spec.getRemoveOperationIdPrefixDelimiter().convention("_");
+        spec.getRemoveOperationIdPrefixCount().convention(1);
+        spec.getSortModelPropertiesByRequiredFlag().convention(true);
+        spec.getEnsureUniqueParams().convention(true);
+        spec.getAllowUnicodeIdentifiers().convention(false);
+        spec.getPrependFormOrBodyParameters().convention(false);
+
         withJava(() -> {
                 var compileOnlyDeps = project.getConfigurations().getByName("compileOnly").getDependencies();
                 if ("java".equalsIgnoreCase(spec.getLang().get())) {
@@ -190,9 +210,26 @@ private void configureCommonProperties(String name, AbstractOpenApiGenerator<?,
         task.getModelNamePrefix().convention(openApiSpec.getModelNamePrefix());
         task.getModelNameSuffix().convention(openApiSpec.getModelNameSuffix());
 
+        task.getUseEnumCaseInsensitive().convention(openApiSpec.getUseEnumCaseInsensitive());
         task.getGenerateSwaggerAnnotations().convention(openApiSpec.getGenerateSwaggerAnnotations());
         task.getImplicitHeaders().convention(openApiSpec.getImplicitHeaders());
         task.getImplicitHeadersRegex().convention(openApiSpec.getImplicitHeadersRegex());
+
+        task.getAdditionalEnumTypeAnnotations().convention(openApiSpec.getAdditionalEnumTypeAnnotations());
+        task.getAdditionalModelTypeAnnotations().convention(openApiSpec.getAdditionalModelTypeAnnotations());
+        task.getAdditionalOneOfTypeAnnotations().convention(openApiSpec.getAdditionalOneOfTypeAnnotations());
+        task.getAdditionalProperties().convention(openApiSpec.getAdditionalProperties());
+
+        task.getUseJakartaEe().convention(openApiSpec.getUseJakartaEe());
+        task.getSortParamsByRequiredFlag().convention(openApiSpec.getSortParamsByRequiredFlag());
+        task.getSkipOperationExample().convention(openApiSpec.getSkipOperationExample());
+        task.getSkipSortingOperations().convention(openApiSpec.getSkipSortingOperations());
+        task.getRemoveOperationIdPrefixDelimiter().convention(openApiSpec.getRemoveOperationIdPrefixDelimiter());
+        task.getRemoveOperationIdPrefixCount().convention(openApiSpec.getRemoveOperationIdPrefixCount());
+        task.getSortModelPropertiesByRequiredFlag().convention(openApiSpec.getSortModelPropertiesByRequiredFlag());
+        task.getEnsureUniqueParams().convention(openApiSpec.getEnsureUniqueParams());
+        task.getAllowUnicodeIdentifiers().convention(openApiSpec.getAllowUnicodeIdentifiers());
+        task.getPrependFormOrBodyParameters().convention(openApiSpec.getPrependFormOrBodyParameters());
     }
 
     private void withJavaSourceSets(Consumer<? super SourceSetContainer> consumer) {

diff --git a/openapi-plugin/src/main/java/io/micronaut/gradle/openapi/OpenApiSpec.java b/openapi-plugin/src/main/java/io/micronaut/gradle/openapi/OpenApiSpec.java
@@ -18,6 +18,8 @@
 import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.MapProperty;
 import org.gradle.api.provider.Property;
+import org.gradle.api.tasks.Input;
+import org.gradle.api.tasks.Optional;
 
 public interface OpenApiSpec {
 
@@ -83,9 +85,39 @@ public interface OpenApiSpec {
 
     Property<String> getModelNameSuffix();
 
+    Property<Boolean> getUseEnumCaseInsensitive();
+
     Property<Boolean> getGenerateSwaggerAnnotations();
 
     Property<Boolean> getImplicitHeaders();
 
     Property<String> getImplicitHeadersRegex();
+
+    ListProperty<String> getAdditionalEnumTypeAnnotations();
+
+    ListProperty<String> getAdditionalModelTypeAnnotations();
+
+    ListProperty<String> getAdditionalOneOfTypeAnnotations();
+
+    MapProperty<String, Object> getAdditionalProperties();
+
+    Property<Boolean> getUseJakartaEe();
+
+    Property<Boolean> getSortParamsByRequiredFlag();
+
+    Property<Boolean> getSkipOperationExample();
+
+    Property<Boolean> getSkipSortingOperations();
+
+    Property<String> getRemoveOperationIdPrefixDelimiter();
+
+    Property<Integer> getRemoveOperationIdPrefixCount();
+
+    Property<Boolean> getSortModelPropertiesByRequiredFlag();
+
+    Property<Boolean> getEnsureUniqueParams();
+
+    Property<Boolean> getAllowUnicodeIdentifiers();
+
+    Property<Boolean> getPrependFormOrBodyParameters();
 }
diff --git a/openapi-plugin/src/main/java/io/micronaut/gradle/openapi/tasks/AbstractOpenApiGenerator.java b/openapi-plugin/src/main/java/io/micronaut/gradle/openapi/tasks/AbstractOpenApiGenerator.java
@@ -146,6 +146,10 @@ public abstract class AbstractOpenApiGenerator<W extends AbstractOpenApiWorkActi
     @Input
     public abstract Property<String> getModelNameSuffix();
 
+    @Optional
+    @Input
+    public abstract Property<Boolean> getUseEnumCaseInsensitive();
+
     @Optional
     @Input
     public abstract Property<Boolean> getGenerateSwaggerAnnotations();
@@ -158,6 +162,62 @@ public abstract class AbstractOpenApiGenerator<W extends AbstractOpenApiWorkActi
     @Input
     public abstract Property<String> getImplicitHeadersRegex();
 
+    @Optional
+    @Input
+    public abstract ListProperty<String> getAdditionalEnumTypeAnnotations();
+
+    @Optional
+    @Input
+    public abstract ListProperty<String> getAdditionalModelTypeAnnotations();
+
+    @Optional
+    @Input
+    public abstract ListProperty<String> getAdditionalOneOfTypeAnnotations();
+
+    @Optional
+    @Input
+    public abstract MapProperty<String, Object> getAdditionalProperties();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getUseJakartaEe();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getSortParamsByRequiredFlag();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getSkipOperationExample();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getSkipSortingOperations();
+
+    @Optional
+    @Input
+    public abstract Property<String> getRemoveOperationIdPrefixDelimiter();
+
+    @Optional
+    @Input
+    public abstract Property<Integer> getRemoveOperationIdPrefixCount();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getSortModelPropertiesByRequiredFlag();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getEnsureUniqueParams();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getAllowUnicodeIdentifiers();
+
+    @Optional
+    @Input
+    public abstract Property<Boolean> getPrependFormOrBodyParameters();
+
     @OutputDirectory
     public abstract DirectoryProperty getOutputDirectory();
 
@@ -209,10 +269,27 @@ public final void execute() {
                 params.getModelNamePrefix().set(getModelNamePrefix().orElse(""));
                 params.getModelNameSuffix().set(getModelNameSuffix().orElse(""));
 
+                params.getUseEnumCaseInsensitive().set(getUseEnumCaseInsensitive());
                 params.getGenerateSwaggerAnnotations().set(getGenerateSwaggerAnnotations());
                 params.getImplicitHeaders().set(getImplicitHeaders());
                 params.getImplicitHeadersRegex().set(getImplicitHeadersRegex().orElse(""));
 
+                params.getAdditionalEnumTypeAnnotations().set(getAdditionalEnumTypeAnnotations());
+                params.getAdditionalModelTypeAnnotations().set(getAdditionalModelTypeAnnotations());
+                params.getAdditionalOneOfTypeAnnotations().set(getAdditionalOneOfTypeAnnotations());
+                params.getAdditionalProperties().set(getAdditionalProperties());
+
+                params.getUseJakartaEe().set(getUseJakartaEe().get());
+                params.getSortParamsByRequiredFlag().set(getSortParamsByRequiredFlag().get());
+                params.getSkipOperationExample().set(getSkipOperationExample().get());
+                params.getSkipSortingOperations().set(getSkipSortingOperations().get());
+                params.getRemoveOperationIdPrefixDelimiter().set(getRemoveOperationIdPrefixDelimiter().get());
+                params.getRemoveOperationIdPrefixCount().set(getRemoveOperationIdPrefixCount().get());
+                params.getSortModelPropertiesByRequiredFlag().set(getSortModelPropertiesByRequiredFlag().get());
+                params.getEnsureUniqueParams().set(getEnsureUniqueParams().get());
+                params.getAllowUnicodeIdentifiers().set(getAllowUnicodeIdentifiers().get());
+                params.getPrependFormOrBodyParameters().set(getPrependFormOrBodyParameters().get());
+
                 configureWorkerParameters(params);
             });
     }

diff --git a/...api-plugin/src/main/java/io/micronaut/gradle/openapi/tasks/AbstractOpenApiWorkAction.java b/...api-plugin/src/main/java/io/micronaut/gradle/openapi/tasks/AbstractOpenApiWorkAction.java
@@ -106,11 +106,41 @@ interface OpenApiParameters extends WorkParameters {
 
         Property<String> getModelNameSuffix();
 
+        Property<Boolean> getUseEnumCaseInsensitive();
+
         Property<Boolean> getGenerateSwaggerAnnotations();
 
         Property<Boolean> getImplicitHeaders();
 
         Property<String> getImplicitHeadersRegex();
+
+        ListProperty<String> getAdditionalEnumTypeAnnotations();
+
+        ListProperty<String> getAdditionalModelTypeAnnotations();
+
+        ListProperty<String> getAdditionalOneOfTypeAnnotations();
+
+        MapProperty<String, Object> getAdditionalProperties();
+
+        Property<Boolean> getUseJakartaEe();
+
+        Property<Boolean> getSortParamsByRequiredFlag();
+
+        Property<Boolean> getSkipOperationExample();
+
+        Property<Boolean> getSkipSortingOperations();
+
+        Property<String> getRemoveOperationIdPrefixDelimiter();
+
+        Property<Integer> getRemoveOperationIdPrefixCount();
+
+        Property<Boolean> getSortModelPropertiesByRequiredFlag();
+
+        Property<Boolean> getEnsureUniqueParams();
+
+        Property<Boolean> getAllowUnicodeIdentifiers();
+
+        Property<Boolean> getPrependFormOrBodyParameters();
     }
 
     protected abstract void configureBuilder(MicronautCodeGeneratorBuilder builder);
@@ -131,8 +161,8 @@ public void execute() {
             .withOptions(options -> options
                 .withLang("kotlin".equalsIgnoreCase(lang) ? GeneratorLanguage.KOTLIN : GeneratorLanguage.JAVA)
                 .withApiPackage(parameters.getApiPackageName().get())
-                .withModelPackage(parameters.getModelPackageName().get())
                 .withInvokerPackage(parameters.getInvokerPackageName().get())
+                .withModelPackage(parameters.getModelPackageName().get())
                 .withBeanValidation(parameters.getUseBeanValidation().get())
                 .withUseOneOfInterfaces(parameters.getUseOneOfInterfaces().get())
                 .withOptional(parameters.getUseOptional().get())
@@ -172,13 +202,29 @@ public void execute() {
                 .withInlineSchemaNameMapping(parameters.getInlineSchemaNameMapping().get())
                 .withInlineSchemaOption(parameters.getInlineSchemaOption().get())
                 .withOpenapiNormalizer(parameters.getOpenapiNormalizer().get())
-                .withApiNamePrefix(parameters.getApiNamePrefix().orElse("").get())
-                .withApiNameSuffix(parameters.getApiNameSuffix().orElse("").get())
-                .withModelNamePrefix(parameters.getModelNamePrefix().orElse("").get())
-                .withModelNameSuffix(parameters.getModelNameSuffix().orElse("").get())
+                .withApiNamePrefix(parameters.getApiNamePrefix().get())
+                .withApiNameSuffix(parameters.getApiNameSuffix().get())
+                .withModelNamePrefix(parameters.getModelNamePrefix().get())
+                .withModelNameSuffix(parameters.getModelNameSuffix().get())
                 .withGenerateSwaggerAnnotations(parameters.getGenerateSwaggerAnnotations().get())
                 .withImplicitHeaders(parameters.getImplicitHeaders().get())
-                .withImplicitHeadersRegex(parameters.getImplicitHeadersRegex().orElse("").get())
+                .withImplicitHeadersRegex(parameters.getImplicitHeadersRegex().get())
+                .withUseEnumCaseInsensitive(parameters.getUseEnumCaseInsensitive().get())
+                .withAdditionalEnumTypeAnnotations(parameters.getAdditionalEnumTypeAnnotations().get())
+                .withAdditionalModelTypeAnnotations(parameters.getAdditionalModelTypeAnnotations().get())
+                .withAdditionalOneOfTypeAnnotations(parameters.getAdditionalOneOfTypeAnnotations().get())
+                .withAdditionalProperties(parameters.getAdditionalProperties().get())
+
+                .withUseJakartaEe(parameters.getUseJakartaEe().get())
+                .withSortParamsByRequiredFlag(parameters.getSortParamsByRequiredFlag().get())
+                .withSkipOperationExample(parameters.getSkipOperationExample().get())
+                .withSkipSortingOperations(parameters.getSkipSortingOperations().get())
+                .withRemoveOperationIdPrefixDelimiter(parameters.getRemoveOperationIdPrefixDelimiter().get())
+                .withRemoveOperationIdPrefixCount(parameters.getRemoveOperationIdPrefixCount().get())
+                .withSortModelPropertiesByRequiredFlag(parameters.getSortModelPropertiesByRequiredFlag().get())
+                .withEnsureUniqueParams(parameters.getEnsureUniqueParams().get())
+                .withAllowUnicodeIdentifiers(parameters.getAllowUnicodeIdentifiers().get())
+                .withPrependFormOrBodyParameters(parameters.getPrependFormOrBodyParameters().get())
             );
 
         configureBuilder(builder);

diff --git a/openapi-plugin/src/test/groovy/io/micronaut/openapi/gradle/OpenApiClientGeneratorSpec.groovy b/openapi-plugin/src/test/groovy/io/micronaut/openapi/gradle/OpenApiClientGeneratorSpec.groovy
@@ -68,8 +68,8 @@ class OpenApiClientGeneratorSpec extends AbstractOpenApiGeneratorSpec {
                         fluxForArrays = true
                         nameMapping = [test: "changedTest"]
                         clientId = "my-client"
-                        generateSwaggerAnnotations = true
                         implicitHeadersRegex = ".*"
+                        useEnumCaseInsensitive = true
                     }
                 }
             }