[Java][Spring] Omit annotation attributes with default values

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/SpringCodegen.java

@@ -63,6 +63,7 @@
 import java.util.*;
 import java.util.regex.Matcher;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 import static org.apache.commons.lang3.StringUtils.isNotEmpty;
 import static org.openapitools.codegen.CodegenConstants.*;
@@ -1126,87 +1127,110 @@ public void preprocessOpenAPI(OpenAPI openAPI) {
 
     @Override
     public OperationsMap postProcessOperationsWithModels(OperationsMap objs, List<ModelMap> allModels) {
-        final OperationMap operations = objs.getOperations();
-        if (operations != null) {
-            final List<CodegenOperation> ops = operations.getOperation();
-            for (final CodegenOperation operation : ops) {
-                final List<CodegenResponse> responses = operation.responses;
-                if (responses != null) {
-                    for (final CodegenResponse resp : responses) {
-                        if ("0".equals(resp.code)) {
-                            resp.code = "200";
-                        }
-                        doDataTypeAssignment(resp.dataType, new DataTypeAssigner() {
-                            @Override
-                            public void setReturnType(final String returnType) {
-                                resp.dataType = returnType;
-                            }
-
-                            @Override
-                            public void setReturnContainer(final String returnContainer) {
-                                resp.containerType = returnContainer;
-                            }
-
-                            @Override
-                            public void setIsVoid(boolean isVoid) {
-                                resp.isVoid = isVoid;
-                            }
-                        });
-                    }
-                }
-
-                doDataTypeAssignment(operation.returnType, new DataTypeAssigner() {
+        removeImport(objs, "java.util.List");
 
-                    @Override
-                    public void setReturnType(final String returnType) {
-                        operation.returnType = returnType;
-                    }
+        final OperationMap operations = objs.getOperations();
+        if (operations == null) {
+            return objs;
+        }
 
-                    @Override
-                    public void setReturnContainer(final String returnContainer) {
-                        operation.returnContainer = returnContainer;
-                    }
+        final List<CodegenOperation> ops = operations.getOperation();
+        for (final CodegenOperation operation : ops) {
+            clearEmptyDescriptions(operation);
+            postProcessResponses(operation.responses);
 
-                    @Override
-                    public void setIsVoid(boolean isVoid) {
-                        operation.isVoid = isVoid;
-                    }
-                });
+            doDataTypeAssignment(operation.returnType, new DataTypeAssigner() {
 
-                prepareVersioningParameters(ops);
-                handleImplicitHeaders(operation);
-                normalizeVendorExtensionWithStringList(operation.vendorExtensions, VendorExtension.X_OPERATION_EXTRA_ANNOTATION.getName());
-                normalizeOperationParameterVendorExtensions(operation, VendorExtension.X_FIELD_EXTRA_ANNOTATION.getName());
+                @Override
+                public void setReturnType(final String returnType) {
+                    operation.returnType = returnType;
+                }
 
-                if (useSpringSecurityPreAuthorize) {
-                    addSpringSecurityPreAuthorize(operation);
+                @Override
+                public void setReturnContainer(final String returnContainer) {
+                    operation.returnContainer = returnContainer;
                 }
 
-                if (isLibrary(SPRING_HTTP_INTERFACE) || isLibrary(SPRING_BOOT)) {
-                    if (operation.isArray && "string".equalsIgnoreCase(operation.returnBaseType)) {
-                        operation.vendorExtensions.put(VendorExtension.X_REACTIVE_RETURN_EXCEPT_LIST_OF_STRING.getName(), true);
-                    }
+                @Override
+                public void setIsVoid(boolean isVoid) {
+                    operation.isVoid = isVoid;
                 }
+            });
+
+            prepareVersioningParameters(ops);
+            handleImplicitHeaders(operation);
+            normalizeVendorExtensionWithStringList(operation.vendorExtensions, VendorExtension.X_OPERATION_EXTRA_ANNOTATION.getName());
+            normalizeOperationParameterVendorExtensions(operation, VendorExtension.X_FIELD_EXTRA_ANNOTATION.getName());
+
+            if (useSpringSecurityPreAuthorize) {
+                addSpringSecurityPreAuthorize(operation);
             }
-            // The tag for the controller is the first tag of the first operation
-            final CodegenOperation firstOperation = ops.get(0);
-            final Tag firstTag = firstOperation.tags.get(0);
-            final String firstTagName = firstTag.getName();
-            // But use a sensible tag name if there is none
-            objs.put("tagName", escapeText("default".equals(firstTagName) ? firstOperation.baseName : firstTagName));
-            objs.put("tagDescription", escapeText(firstTag.getDescription()));
-
-            // Add clientRegistrationId for spring-http-interface with OAuth
-            if (SPRING_HTTP_INTERFACE.equals(library) && clientRegistrationId != null && !clientRegistrationId.isEmpty()) {
-                operations.put("clientRegistrationId", clientRegistrationId);
+
+            if ((isLibrary(SPRING_HTTP_INTERFACE) || isLibrary(SPRING_BOOT))
+                    && operation.isArray && "string".equalsIgnoreCase(operation.returnBaseType)) {
+                operation.vendorExtensions.put(VendorExtension.X_REACTIVE_RETURN_EXCEPT_LIST_OF_STRING.getName(), true);
             }
         }
+        // The tag for the controller is the first tag of the first operation
+        final CodegenOperation firstOperation = ops.get(0);
+        final Tag firstTag = firstOperation.tags.get(0);
+        final String firstTagName = firstTag.getName();
+        // But use a sensible tag name if there is none
+        objs.put("tagName", escapeText("default".equals(firstTagName) ? firstOperation.baseName : firstTagName));
+        objs.put("tagDescription", escapeText(firstTag.getDescription()));
 
-        removeImport(objs, "java.util.List");
+        // Add clientRegistrationId for spring-http-interface with OAuth
+        if (SPRING_HTTP_INTERFACE.equals(library) && clientRegistrationId != null && !clientRegistrationId.isEmpty()) {
+            operations.put("clientRegistrationId", clientRegistrationId);
+        }
 
         return objs;
     }
 
+    /**
+     * Treats empty descriptions as absent, so templates omit annotation attributes like {@code description = ""}.
+     */
+    private static void clearEmptyDescriptions(CodegenOperation operation) {
+        if (StringUtils.isEmpty(operation.notes)) {
+            operation.notes = null;
+        }
+        Stream.of(operation.allParams, operation.bodyParams, operation.pathParams, operation.queryParams,
+                        operation.headerParams, operation.implicitHeadersParams, operation.formParams, operation.cookieParams,
+                        operation.requiredParams, operation.optionalParams, operation.requiredAndNotNullableParams,
+                        operation.notNullableParams)
+                .filter(Objects::nonNull)
+                .flatMap(List::stream)
+                .filter(param -> StringUtils.isEmpty(param.description))
+                .forEach(param -> param.description = null);
+    }
+
+    private void postProcessResponses(List<CodegenResponse> responses) {
+        if (responses == null) {
+            return;
+        }
+        for (final CodegenResponse resp : responses) {
+            if ("0".equals(resp.code)) {
+                resp.code = "200";
+            }
+            doDataTypeAssignment(resp.dataType, new DataTypeAssigner() {
+                @Override
+                public void setReturnType(final String returnType) {
+                    resp.dataType = returnType;
+                }
+
+                @Override
+                public void setReturnContainer(final String returnContainer) {
+                    resp.containerType = returnContainer;
+                }
+
+                @Override
+                public void setIsVoid(boolean isVoid) {
+                    resp.isVoid = isVoid;
+                }
+            });
+        }
+    }
+
     /**
      * Adds a Spring Security expression that preserves the OpenAPI security requirement semantics:
      * entries in a {@code security} array are OR alternatives, while schemes and scopes in one

modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache

@@ -1 +1 @@
-{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} {{>beanValidationBodyParams}}{{^isContainer}}{{#isModel}}@Valid {{/isModel}}{{^isModel}}{{^useOptional}}@Valid {{/useOptional}}{{#useOptional}}{{#required}}@Valid {{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^useBeanValidation}} {{/useBeanValidation}}{{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{^required}}{{#useOptional}}Optional<{{/useOptional}}{{/required}}{{{dataType}}}{{^required}}{{#useOptional}}>{{/useOptional}}{{/required}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} {{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}@RequestPart(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}) {{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isFile}}{{/isFormParam}}
+{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} {{>beanValidationBodyParams}}{{^isContainer}}{{#isModel}}@Valid {{/isModel}}{{^isModel}}{{^useOptional}}@Valid {{/useOptional}}{{#useOptional}}{{#required}}@Valid {{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^useBeanValidation}} {{/useBeanValidation}}{{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{^required}}{{#useOptional}}Optional<{{/useOptional}}{{/required}}{{{dataType}}}{{^required}}{{#useOptional}}>{{/useOptional}}{{/required}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} {{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}@RequestPart(value = "{{baseName}}"{{^required}}, required = false{{/required}}) {{#reactive}}{{#isArray}}Flux<{{/isArray}}Part{{#isArray}}>{{/isArray}}{{/reactive}}{{^reactive}}{{#isArray}}List<{{/isArray}}MultipartFile{{#isArray}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isFile}}{{/isFormParam}}

modules/openapi-generator/src/main/resources/JavaSpring/headerParams.mustache

@@ -1 +1 @@
-{{#isHeaderParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}} @RequestHeader(value = "{{baseName}}", required = {{#required}}true{{/required}}{{^required}}false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{>dateTimeParam}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isHeaderParam}}
+{{#isHeaderParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}} @RequestHeader(value = "{{baseName}}"{{^required}}, required = false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{>dateTimeParam}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isHeaderParam}}

modules/openapi-generator/src/main/resources/JavaSpring/paramDoc.mustache

@@ -1 +1 @@
-{{#swagger2AnnotationLibrary}}@Parameter(name = "{{{baseName}}}"{{#isDeprecated}}, deprecated = true{{/isDeprecated}}, description = "{{{description}}}"{{#required}}, required = true{{/required}}{{#isPathParam}}, in = ParameterIn.PATH{{/isPathParam}}{{#isQueryParam}}, in = ParameterIn.QUERY{{/isQueryParam}}{{#isCookieParam}}, in = ParameterIn.COOKIE{{/isCookieParam}}{{#isHeaderParam}}, in = ParameterIn.HEADER{{/isHeaderParam}}){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}@ApiParam(value = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}, {{> allowableValues }}{{/allowableValues}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/swagger1AnnotationLibrary}}
+{{#swagger2AnnotationLibrary}}@Parameter(name = "{{{baseName}}}"{{#isDeprecated}}, deprecated = true{{/isDeprecated}}{{#description}}, description = "{{{.}}}"{{/description}}{{#required}}, required = true{{/required}}{{#isPathParam}}, in = ParameterIn.PATH{{/isPathParam}}{{#isQueryParam}}, in = ParameterIn.QUERY{{/isQueryParam}}{{#isCookieParam}}, in = ParameterIn.COOKIE{{/isCookieParam}}{{#isHeaderParam}}, in = ParameterIn.HEADER{{/isHeaderParam}}){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}@ApiParam(value = "{{{description}}}"{{#required}}, required = true{{/required}}{{#allowableValues}}, {{> allowableValues }}{{/allowableValues}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/swagger1AnnotationLibrary}}

modules/openapi-generator/src/main/resources/JavaSpring/queryParams.mustache

@@ -1 +1 @@
-{{#isQueryParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}}{{#useBeanValidation}}{{^isContainer}}{{#isModel}} @Valid{{/isModel}}{{^isModel}}{{^useOptional}} @Valid{{/useOptional}}{{#useOptional}}{{#required}} @Valid{{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^isModel}} @RequestParam(value = {{#isMap}}""{{/isMap}}{{^isMap}}"{{baseName}}"{{/isMap}}{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/isModel}}{{>dateTimeParam}}{{#isDeprecated}} @Deprecated{{/isDeprecated}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isQueryParam}}
+{{#isQueryParam}}{{#vendorExtensions.x-field-extra-annotation}}{{{.}}} {{/vendorExtensions.x-field-extra-annotation}}{{#useBeanValidation}}{{>beanValidationQueryParams}}{{/useBeanValidation}}{{>paramDoc}}{{#useBeanValidation}}{{^isContainer}}{{#isModel}} @Valid{{/isModel}}{{^isModel}}{{^useOptional}} @Valid{{/useOptional}}{{#useOptional}}{{#required}} @Valid{{/required}}{{/useOptional}}{{/isModel}}{{/isContainer}}{{/useBeanValidation}}{{^isModel}} @RequestParam(value = {{#isMap}}""{{/isMap}}{{^isMap}}"{{baseName}}"{{/isMap}}{{^required}}, required = false{{/required}}{{#defaultValue}}, defaultValue = "{{{.}}}"{{/defaultValue}}){{/isModel}}{{>dateTimeParam}}{{#isDeprecated}} @Deprecated{{/isDeprecated}} {{>nullableAnnotation}}{{>optionalDataType}} {{paramName}}{{/isQueryParam}}