Fixes for extensions and in templates.

Removed support swagger1 annotations
micronaut-projects · Sep 25, 2024 · 84a3265 · 84a3265
1 parent 225071a
commit 84a3265
Show file tree

Hide file tree

Showing 25 changed files with 564 additions and 102 deletions.
diff --git a/...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java b/...-generator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautJavaCodegen.java
@@ -41,6 +41,7 @@
 import org.openapitools.codegen.CodegenParameter;
 import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.SupportingFile;
+import org.openapitools.codegen.VendorExtension;
 import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.languages.AbstractJavaCodegen;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
@@ -130,7 +131,6 @@ public abstract class AbstractMicronautJavaCodegen<T extends GeneratorOptionsBui
     public static final String CONTENT_TYPE_APPLICATION_JSON = "application/json";
     public static final String CONTENT_TYPE_MULTIPART_FORM_DATA = "multipart/form-data";
     public static final String CONTENT_TYPE_ANY = "*/*";
-    public static final String EXT_CONTENT_TYPE = "x-content-type";
 
     private static final String MONO_CLASS_NAME = "reactor.core.publisher.Mono";
     private static final String FLUX_CLASS_NAME = "reactor.core.publisher.Flux";
@@ -248,7 +248,6 @@ protected AbstractMicronautJavaCodegen() {
 
         var generateSwaggerAnnotationsOption = new CliOption(OPT_GENERATE_SWAGGER_ANNOTATIONS, "Specify if you want to generate swagger annotations and which version").defaultValue(generateSwaggerAnnotations);
         var generateSwaggerAnnotationsOptionMap = new HashMap<String, String>();
-        generateSwaggerAnnotationsOptionMap.put(OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_1, "Use io.swagger:swagger-annotations for annotating operations and schemas");
         generateSwaggerAnnotationsOptionMap.put(OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2, "Use io.swagger.core.v3:swagger-annotations for annotating operations and schemas");
         generateSwaggerAnnotationsOptionMap.put(OPT_GENERATE_SWAGGER_ANNOTATIONS_TRUE, "Equivalent to \"" + OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2 + "\"");
         generateSwaggerAnnotationsOptionMap.put(OPT_GENERATE_SWAGGER_ANNOTATIONS_FALSE, "Do not generate swagger annotations");
@@ -505,9 +504,7 @@ public void processOpts() {
         }
 
         maybeSetSwagger();
-        if (OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_1.equals(generateSwaggerAnnotations)) {
-            additionalProperties.put("generateSwagger1Annotations", true);
-        } else if (OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2.equals(generateSwaggerAnnotations)) {
+        if (OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2.equals(generateSwaggerAnnotations)) {
             additionalProperties.put("generateSwagger2Annotations", true);
         }
 
@@ -625,8 +622,7 @@ private void maybeSetSwagger() {
         if (additionalProperties.containsKey(OPT_GENERATE_SWAGGER_ANNOTATIONS)) {
             String value = String.valueOf(additionalProperties.get(OPT_GENERATE_SWAGGER_ANNOTATIONS));
             switch (value) {
-                case OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_1 -> generateSwaggerAnnotations = OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_1;
-                case OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2, OPT_GENERATE_SWAGGER_ANNOTATIONS_TRUE -> generateSwaggerAnnotations = OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2;
+                case OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_1, OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2, OPT_GENERATE_SWAGGER_ANNOTATIONS_TRUE -> generateSwaggerAnnotations = OPT_GENERATE_SWAGGER_ANNOTATIONS_SWAGGER_2;
                 case OPT_GENERATE_SWAGGER_ANNOTATIONS_FALSE -> generateSwaggerAnnotations = OPT_GENERATE_SWAGGER_ANNOTATIONS_FALSE;
                 default -> throw new RuntimeException("Value \"" + value + "\" for the " + OPT_GENERATE_SWAGGER_ANNOTATIONS + " parameter is unsupported or misspelled");
             }
@@ -1215,8 +1211,8 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             }
 
             // Remove the "*/*" contentType from operations as it is ambiguous
-            if (CONTENT_TYPE_ANY.equals(op.vendorExtensions.get(EXT_CONTENT_TYPE))) {
-                op.vendorExtensions.put(EXT_CONTENT_TYPE, CONTENT_TYPE_APPLICATION_JSON);
+            if (CONTENT_TYPE_ANY.equals(op.vendorExtensions.get(VendorExtension.X_CONTENT_TYPE.getName()))) {
+                op.vendorExtensions.put(VendorExtension.X_CONTENT_TYPE.getName(), CONTENT_TYPE_APPLICATION_JSON);
             }
             op.consumes = op.consumes == null ? null : op.consumes.stream()
                 .filter(contentType -> !CONTENT_TYPE_ANY.equals(contentType.get("mediaType")))
@@ -1241,14 +1237,14 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             // Force form parameters are only set if the content-type is according
             // formParams correspond to urlencoded type
             // bodyParams correspond to multipart body
-            if (CONTENT_TYPE_APPLICATION_FORM_URLENCODED.equals(op.vendorExtensions.get(EXT_CONTENT_TYPE))) {
+            if (CONTENT_TYPE_APPLICATION_FORM_URLENCODED.equals(op.vendorExtensions.get(VendorExtension.X_CONTENT_TYPE.getName()))) {
                 op.formParams.addAll(op.bodyParams);
                 op.bodyParams.forEach(p -> {
                     p.isBodyParam = false;
                     p.isFormParam = true;
                 });
                 op.bodyParams.clear();
-            } else if (CONTENT_TYPE_MULTIPART_FORM_DATA.equals(op.vendorExtensions.get(EXT_CONTENT_TYPE))) {
+            } else if (CONTENT_TYPE_MULTIPART_FORM_DATA.equals(op.vendorExtensions.get(VendorExtension.X_CONTENT_TYPE.getName()))) {
                 op.bodyParams.addAll(op.formParams);
                 for (var param : op.allParams) {
                     if (param.isFormParam) {

diff --git a/...enerator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java b/...enerator/src/main/java/io/micronaut/openapi/generator/AbstractMicronautKotlinCodegen.java
@@ -44,6 +44,7 @@
 import org.openapitools.codegen.CodegenProperty;
 import org.openapitools.codegen.DefaultCodegen;
 import org.openapitools.codegen.SupportingFile;
+import org.openapitools.codegen.VendorExtension;
 import org.openapitools.codegen.config.GlobalSettings;
 import org.openapitools.codegen.languages.AbstractKotlinCodegen;
 import org.openapitools.codegen.languages.features.BeanValidationFeatures;
@@ -136,7 +137,6 @@ public abstract class AbstractMicronautKotlinCodegen<T extends GeneratorOptionsB
     public static final String CONTENT_TYPE_APPLICATION_JSON = "application/json";
     public static final String CONTENT_TYPE_MULTIPART_FORM_DATA = "multipart/form-data";
     public static final String CONTENT_TYPE_ANY = "*/*";
-    public static final String EXT_CONTENT_TYPE = "x-content-type";
 
     private static final String MONO_CLASS_NAME = "reactor.core.publisher.Mono";
     private static final String FLUX_CLASS_NAME = "reactor.core.publisher.Flux";
@@ -890,21 +890,21 @@ public void preprocessOpenAPI(OpenAPI openApi) {
 
         if (openApi.getPaths() != null) {
             for (Map.Entry<String, PathItem> openAPIGetPathsEntry : openApi.getPaths().entrySet()) {
-                String pathname = openAPIGetPathsEntry.getKey();
                 PathItem path = openAPIGetPathsEntry.getValue();
-                if (path.readOperations() == null) {
+                var ops = path.readOperations();
+                if (ops == null || ops.isEmpty()) {
                     continue;
                 }
-                for (Operation operation : path.readOperations()) {
+                for (Operation operation : ops) {
                     log.info("Processing operation {}", operation.getOperationId());
                     if (hasBodyParameter(operation) || hasFormParameter(operation)) {
                         var defaultContentType = hasFormParameter(operation) ? CONTENT_TYPE_APPLICATION_FORM_URLENCODED : CONTENT_TYPE_APPLICATION_JSON;
                         var consumes = new ArrayList<>(getConsumesInfo(openApi, operation));
                         String contentType = consumes.isEmpty() ? defaultContentType : consumes.get(0);
-                        operation.addExtension(EXT_CONTENT_TYPE, contentType);
+                        operation.addExtension(VendorExtension.X_CONTENT_TYPE.getName(), contentType);
                     }
-                    String[] accepts = getAccepts(openAPI, operation);
-                    operation.addExtension("x-accepts", accepts);
+                    String[] accepts = getAccepts(openApi, operation);
+                    operation.addExtension(VendorExtension.X_ACCEPTS.getName(), accepts);
                 }
             }
         }
@@ -968,8 +968,8 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             }
 
             // Remove the "*/*" contentType from operations as it is ambiguous
-            if (CONTENT_TYPE_ANY.equals(op.vendorExtensions.get(EXT_CONTENT_TYPE))) {
-                op.vendorExtensions.put(EXT_CONTENT_TYPE, CONTENT_TYPE_APPLICATION_JSON);
+            if (CONTENT_TYPE_ANY.equals(op.vendorExtensions.get(VendorExtension.X_CONTENT_TYPE.getName()))) {
+                op.vendorExtensions.put(VendorExtension.X_CONTENT_TYPE.getName(), CONTENT_TYPE_APPLICATION_JSON);
             }
             op.consumes = op.consumes == null ? null : op.consumes.stream()
                 .filter(contentType -> !CONTENT_TYPE_ANY.equals(contentType.get("mediaType")))
@@ -994,14 +994,14 @@ public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<Mo
             // Force form parameters are only set if the content-type is according
             // formParams correspond to urlencoded type
             // bodyParams correspond to multipart body
-            if (CONTENT_TYPE_APPLICATION_FORM_URLENCODED.equals(op.vendorExtensions.get(EXT_CONTENT_TYPE))) {
+            if (CONTENT_TYPE_APPLICATION_FORM_URLENCODED.equals(op.vendorExtensions.get(VendorExtension.X_CONTENT_TYPE.getName()))) {
                 op.formParams.addAll(op.bodyParams);
                 op.bodyParams.forEach(p -> {
                     p.isBodyParam = false;
                     p.isFormParam = true;
                 });
                 op.bodyParams.clear();
-            } else if (CONTENT_TYPE_MULTIPART_FORM_DATA.equals(op.vendorExtensions.get(EXT_CONTENT_TYPE))) {
+            } else if (CONTENT_TYPE_MULTIPART_FORM_DATA.equals(op.vendorExtensions.get(VendorExtension.X_CONTENT_TYPE.getName()))) {
                 op.bodyParams.addAll(op.formParams);
                 for (var param : op.allParams) {
                     if (param.isFormParam) {

diff --git a/openapi-generator/src/main/java/io/micronaut/openapi/generator/Utils.java b/openapi-generator/src/main/java/io/micronaut/openapi/generator/Utils.java
@@ -156,7 +156,7 @@ private static String genericAnnotations(CodegenProperty prop, boolean isGenerat
         }
 
         if (StringUtils.isNotEmpty(prop.pattern) && !prop.isDate && !prop.isDateTime) {
-            if ("email".equals(type)) {
+            if (prop.isEmail) {
                 result.append("@Email(regexp = \"");
             } else {
                 result.append("@Pattern(regexp = \"");
@@ -271,8 +271,7 @@ private static boolean isPrimitive(String type) {
         }
         return switch (type) {
             case "array", "string", "boolean", "byte", "uri", "url", "uuid", "email", "integer", "long", "float",
-                 "double",
-                 "number", "partial-time", "date", "date-time", "bigdecimal", "biginteger" -> true;
+                 "double", "number", "partial-time", "date", "date-time", "bigdecimal", "decimal", "biginteger" -> true;
             default -> false;
         };
     }

diff --git a/openapi-generator/src/main/resources/templates/java-micronaut/client/api.mustache b/openapi-generator/src/main/resources/templates/java-micronaut/client/api.mustache
@@ -29,9 +29,6 @@ import java.util.Map;
 import {{javaxPackage}}.validation.Valid;
 import {{javaxPackage}}.validation.constraints.*;
 {{/useBeanValidation}}
-{{#generateSwagger1Annotations}}
-import io.swagger.annotations.*;
-{{/generateSwagger1Annotations}}
 {{#generateSwagger2Annotations}}
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;

diff --git a/openapi-generator/src/main/resources/templates/java-micronaut/client/params/type.mustache b/openapi-generator/src/main/resources/templates/java-micronaut/client/params/type.mustache
@@ -1,3 +1,4 @@
+{{#isDeprecated}}@Deprecated{{/isDeprecated}}
 {{^isDate}}{{^isDateTime}}{{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}{{/isDateTime}}{{/isDate}}
 {{#isDateTime}}{{#vendorExtensions.formatPattern}}@Format("{{{vendorExtensions.formatPattern}}}"){{/vendorExtensions.formatPattern}}{{^vendorExtensions.formatPattern}}{{#dateTimeFormat}}@Format("{{{dateTimeFormat}}}"){{/dateTimeFormat}}{{/vendorExtensions.formatPattern}} {{{dataType}}} {{/isDateTime}}
 {{#isDate}}{{#vendorExtensions.formatPattern}}@Format("{{{vendorExtensions.formatPattern}}}"){{/vendorExtensions.formatPattern}}{{^vendorExtensions.formatPattern}}{{#dateFormat}}@Format("{{{dateFormat}}}"){{/dateFormat}}{{/vendorExtensions.formatPattern}} {{{dataType}}} {{/isDate}}
diff --git a/openapi-generator/src/main/resources/templates/java-micronaut/common/model/enum.mustache b/openapi-generator/src/main/resources/templates/java-micronaut/common/model/enum.mustache
@@ -1,6 +1,13 @@
 /**
  * {{^description}}Gets or Sets {{{name}}}{{/description}}{{#description}}{{{.}}}{{/description}}
+{{#isDeprecated}}
+ *
+ * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+{{/isDeprecated}}
  */
+{{#isDeprecated}}
+@Deprecated
+{{/isDeprecated}}
 {{#withXml}}
 @XmlType(name="{{datatypeWithEnum}}")
 @XmlEnum({{dataType}}.class)

diff --git a/openapi-generator/src/main/resources/templates/java-micronaut/common/model/model.mustache b/openapi-generator/src/main/resources/templates/java-micronaut/common/model/model.mustache
@@ -67,10 +67,6 @@ import io.micronaut.core.annotation.Nullable;
 {{#generatedAnnotation}}
 import {{javaxPackage}}.annotation.Generated;
 {{/generatedAnnotation}}
-{{#generateSwagger1Annotations}}
-import io.swagger.annotations.ApiModel;
-import io.swagger.annotations.ApiModelProperty;
-{{/generateSwagger1Annotations}}
 {{#generateSwagger2Annotations}}
 import io.swagger.v3.oas.annotations.media.Schema;
 {{/generateSwagger2Annotations}}

diff --git a/openapi-generator/src/main/resources/templates/java-micronaut/common/model/pojo.mustache b/openapi-generator/src/main/resources/templates/java-micronaut/common/model/pojo.mustache
@@ -1,13 +1,17 @@
 {{#formatNoEmptyLines}}
 /**
  * {{#description}}{{.}}{{/description}}{{^description}}{{classname}}{{/description}}
+{{#isDeprecated}}
+ *
+ * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+{{/isDeprecated}}
  */
+{{#isDeprecated}}
+@Deprecated
+{{/isDeprecated}}
 {{#description}}
-    {{#generateSwagger1Annotations}}
-@ApiModel(description = "{{{description}}}")
-    {{/generateSwagger1Annotations}}
     {{#generateSwagger2Annotations}}
-@Schema({{#name}}name = "{{name}}", {{/name}}description = "{{{description}}}")
+@Schema({{#name}}name = "{{name}}", {{/name}}description = "{{{description}}}"{{#isDeprecated}}, deprecated = true{{/isDeprecated}})
     {{/generateSwagger2Annotations}}
 {{/description}}
 {{#lombok}}
@@ -87,8 +91,22 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#vendorE
         {{#description}}
     /**
      * {{description}}
+        {{#deprecated}}
+     *
+     * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+        {{/deprecated}}
      */
         {{/description}}
+        {{^description}}
+            {{#deprecated}}
+    /**
+     * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+     */
+            {{/deprecated}}
+        {{/description}}
+        {{#deprecated}}
+    @Deprecated
+        {{/deprecated}}
 {{>common/params/validation}}
         {{#withXml}}
             {{#isXmlAttribute}}
@@ -111,11 +129,8 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#vendorE
                 {{/isContainer}}
             {{/isXmlAttribute}}
         {{/withXml}}
-        {{#generateSwagger1Annotations}}
-    @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}")
-        {{/generateSwagger1Annotations}}
         {{#generateSwagger2Annotations}}
-    @Schema(name = "{{{baseName}}}"{{#isReadOnly}}, accessMode = Schema.AccessMode.READ_ONLY{{/isReadOnly}}{{#example}}, example = "{{{.}}}"{{/example}}{{#description}}, description = "{{{.}}}"{{/description}}, requiredMode = {{#required}}Schema.RequiredMode.REQUIRED{{/required}}{{^required}}Schema.RequiredMode.NOT_REQUIRED{{/required}})
+    @Schema(name = "{{{baseName}}}"{{#isReadOnly}}, accessMode = Schema.AccessMode.READ_ONLY{{/isReadOnly}}{{#example}}, example = "{{{.}}}"{{/example}}{{#description}}, description = "{{{.}}}"{{/description}}, requiredMode = {{#required}}Schema.RequiredMode.REQUIRED{{/required}}{{^required}}Schema.RequiredMode.NOT_REQUIRED{{/required}}{{#deprecated}}, deprecated = true{{/deprecated}})
         {{/generateSwagger2Annotations}}
         {{#vendorExtensions.x-is-jackson-optional-nullable}}
             {{!Unannotated, Jackson would pick this up automatically and add it *in addition* to the _JsonNullable getter field}}
@@ -193,10 +208,17 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#vendorE
      *
         {{/description}}
      * @return the {{name}} property value
+    {{#deprecated}}
+     *
+     * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+    {{/deprecated}}
      */
     {{#vendorExtensions.x-extra-annotation}}
     {{{.}}}
     {{/vendorExtensions.x-extra-annotation}}
+    {{#deprecated}}
+    @Deprecated
+    {{/deprecated}}
     {{#isDiscriminator}}
         {{#parent}}
     @Override
@@ -231,10 +253,17 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#vendorE
      *
         {{/description}}
      * @return the {{name}} property value wrapped in an optional
+    {{#deprecated}}
+     *
+     * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+    {{/deprecated}}
      */
     {{#jackson}}
     @JsonIgnore
     {{/jackson}}
+    {{#deprecated}}
+    @Deprecated
+    {{/deprecated}}
     public Optional<{{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}> {{getter}}Optional() {
         {{^vendorExtensions.x-is-jackson-optional-nullable}}
         return Optional.ofNullable({{name}});
@@ -249,10 +278,19 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#vendorE
     {{^vendorExtensions.lombok}}
     /**
      * Set the {{name}} property value
+     *
+     * @param {{name}} property value to set
+    {{#deprecated}}
+     *
+     * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+    {{/deprecated}}
      */
         {{#vendorExtensions.x-setter-extra-annotation}}
     {{{.}}}
         {{/vendorExtensions.x-setter-extra-annotation}}
+    {{#deprecated}}
+    @Deprecated
+    {{/deprecated}}
     public void {{setter}}({{{vendorExtensions.typeWithEnumWithGenericAnnotations}}} {{name}}) {
             {{#vendorExtensions.x-is-jackson-optional-nullable}}
         this.{{name}} = JsonNullable.<{{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}>of({{name}});
@@ -286,7 +324,14 @@ public class {{classname}} {{#parent}}extends {{{parent}}} {{/parent}}{{#vendorE
      * Set {{name}} in a chainable fashion.
      *
      * @return The same instance of {{classname}} for chaining.
+    {{#deprecated}}
+     *
+     * @deprecated{{#vendorExtensions.x-deprecated-message}} {{{.}}}{{/vendorExtensions.x-deprecated-message}}
+    {{/deprecated}}
      */
+    {{#deprecated}}
+    @Deprecated
+    {{/deprecated}}
     public {{classname}} {{name}}({{{vendorExtensions.typeWithEnumWithGenericAnnotations}}} {{name}}) {
             {{#vendorExtensions.x-is-jackson-optional-nullable}}
         this.{{name}} = JsonNullable.<{{{vendorExtensions.typeWithEnumWithGenericAnnotations}}}>of({{name}});