fix(spring): Add Nullable import for array-type models (#22788)

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

@@ -968,11 +968,6 @@ public void postProcessModelProperty(CodegenModel model, CodegenProperty propert
         if (model.getVendorExtensions().containsKey("x-jackson-optional-nullable-helpers")) {
             model.imports.add("Arrays");
         }
-
-        // to prevent inheritors (JavaCamelServerCodegen etc.) mistakenly use it
-        if (getName().contains("spring")) {
-            model.imports.add("Nullable");
-        }
     }
 
     @Override
@@ -989,6 +984,8 @@ public CodegenModel fromModel(String name, Schema model) {
             codegenModel.imports.remove("Schema");
         }
 
+        addSpringNullableImport(codegenModel.imports);
+
         return codegenModel;
     }
 
@@ -1052,11 +1049,7 @@ public CodegenOperation fromOperation(String path, String httpMethod, Operation
             codegenOperation.imports.addAll(provideArgsClassSet);
         }
 
-        // to prevent inheritors (JavaCamelServerCodegen etc.) mistakenly use it
-        if (getName().contains("spring")) {
-          codegenOperation.allParams.stream().filter(CodegenParameter::notRequiredOrIsNullable).findAny()
-              .ifPresent(p -> codegenOperation.imports.add("Nullable"));
-        }
+        addSpringNullableImportForOperation(codegenOperation);
 
         if (reactive) {
             if (DocumentationProvider.SPRINGFOX.equals(getDocumentationProvider())) {
@@ -1219,4 +1212,23 @@ public List<VendorExtension> getSupportedVendorExtensions() {
         extensions.add(VendorExtension.X_SPRING_API_VERSION);
         return extensions;
     }
+
+    private boolean isSpringCodegen() {
+        return getName().contains("spring");
+    }
+
+    private void addSpringNullableImport(Set<String> imports) {
+        if (isSpringCodegen()) {
+            imports.add("Nullable");
+        }
+    }
+
+    private void addSpringNullableImportForOperation(CodegenOperation codegenOperation) {
+        if (isSpringCodegen()) {
+            codegenOperation.allParams.stream()
+                .filter(CodegenParameter::notRequiredOrIsNullable)
+                .findAny()
+                .ifPresent(param -> codegenOperation.imports.add("Nullable"));
+        }
+    }
 }

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/spring/SpringCodegenTest.java

@@ -6223,4 +6223,37 @@ public void testExtensionsOnSchema_issue9183() throws IOException {
                                                                          ));
     }
 
+    @Test
+    public void shouldAddNullableImportForArrayTypeModels() throws IOException {
+        File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
+        output.deleteOnExit();
+
+        final OpenAPI openAPI = TestUtils.parseFlattenSpec(
+                "src/test/resources/3_0/spring/petstore-with-fake-endpoints-models-for-testing-with-spring-pageable.yaml");
+        final SpringCodegen codegen = new SpringCodegen();
+        codegen.setOpenAPI(openAPI);
+        codegen.setOutputDir(output.getAbsolutePath());
+        codegen.additionalProperties().put(INTERFACE_ONLY, "true");
+        codegen.additionalProperties().put(CodegenConstants.GENERATE_ALIAS_AS_MODEL, "true");
+
+        ClientOptInput input = new ClientOptInput();
+        input.openAPI(openAPI);
+        input.config(codegen);
+
+        DefaultGenerator generator = new DefaultGenerator();
+        generator.setGenerateMetadata(false);
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODELS, "true");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_TESTS, "false");
+        generator.setGeneratorPropertyDefault(CodegenConstants.MODEL_DOCS, "false");
+
+        Map<String, File> files = generator.opts(input).generate().stream()
+                .collect(Collectors.toMap(File::getName, Function.identity()));
+
+        // AnimalFarm is an array-type model with no properties (issue #22788)
+        JavaFileAssert.assertThat(files.get("AnimalFarm.java"))
+                .hasImports("org.springframework.lang.Nullable");
+        JavaFileAssert.assertThat(files.get("Pet.java"))
+                .hasImports("org.springframework.lang.Nullable");
+    }
+
 }

samples/client/echo_api/php-nextgen-streaming/phpunit.xml.dist

@@ -2,8 +2,8 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
   <coverage processUncoveredFiles="true">
     <include>
-      <directory suffix=".php">./src/Api</directory>
-      <directory suffix=".php">./src/Model</directory>
+      <directory suffix=".php">./src\/Api</directory>
+      <directory suffix=".php">./src\/Model</directory>
     </include>
   </coverage>
   <testsuites>

samples/client/echo_api/php-nextgen/phpunit.xml.dist

@@ -2,8 +2,8 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
   <coverage processUncoveredFiles="true">
     <include>
-      <directory suffix=".php">./src/Api</directory>
-      <directory suffix=".php">./src/Model</directory>
+      <directory suffix=".php">./src\/Api</directory>
+      <directory suffix=".php">./src\/Model</directory>
     </include>
   </coverage>
   <testsuites>

samples/client/petstore/php-nextgen/OpenAPIClient-php/phpunit.xml.dist

@@ -2,8 +2,8 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="./vendor/autoload.php" colors="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
   <coverage processUncoveredFiles="true">
     <include>
-      <directory suffix=".php">./src/Api</directory>
-      <directory suffix=".php">./src/Model</directory>
+      <directory suffix=".php">./src\/Api</directory>
+      <directory suffix=".php">./src\/Model</directory>
     </include>
   </coverage>
   <testsuites>

samples/client/petstore/powershell/docs/FormatTest.md

@@ -34,7 +34,7 @@ $FormatTest = Initialize-PSPetstoreFormatTest  -Integer null `
  -String null `
  -Byte null `
  -Binary null `
- -Date Sun Feb 02 00:00:00 UTC 2020 `
+ -Date Sat Feb 01 16:00:00 PST 2020 `
  -DateTime 2007-12-03T10:15:30+01:00 `
  -Uuid 72f98069-206d-4f12-9f12-3d1e525a8e84 `
  -Password null `

samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java

@@ -36,7 +36,7 @@ public class Pet {
   private BigDecimal price = new BigDecimal("32000000000");
 
   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
-  private OffsetDateTime lastFeed = OffsetDateTime.parse("1973-12-19T11:39:57Z[UTC]", java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME.withZone(java.time.ZoneId.systemDefault()));
+  private OffsetDateTime lastFeed = OffsetDateTime.parse("1973-12-19T03:39:57-08:00[America/Los_Angeles]", java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME.withZone(java.time.ZoneId.systemDefault()));
 
   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
   private LocalDate dateOfBirth = LocalDate.parse("2021-01-01");

samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/model/EnumClassDto.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface-noResponseEntity/src/main/java/org/openapitools/model/OuterEnumDto.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/model/EnumClass.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface-reactive-noResponseEntity/src/main/java/org/openapitools/model/OuterEnum.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/EnumClass.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface-reactive/src/main/java/org/openapitools/model/OuterEnum.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/model/EnumClassDto.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/client/petstore/spring-http-interface/src/main/java/org/openapitools/model/OuterEnumDto.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/model/Pet.java

@@ -35,7 +35,7 @@ public class Pet {
   private BigDecimal price = new BigDecimal("32000000000");
 
   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME)
-  private OffsetDateTime lastFeed = OffsetDateTime.parse("1973-12-19T11:39:57Z[UTC]", java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME.withZone(java.time.ZoneId.systemDefault()));
+  private OffsetDateTime lastFeed = OffsetDateTime.parse("1973-12-19T03:39:57-08:00[America/Los_Angeles]", java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME.withZone(java.time.ZoneId.systemDefault()));
 
   @DateTimeFormat(iso = DateTimeFormat.ISO.DATE)
   private LocalDate dateOfBirth = LocalDate.parse("2021-01-01");

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/EnumClass.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/model/OuterEnum.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/spring-boot-oneof-interface/src/main/java/org/openapitools/model/FruitType.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/spring-boot-oneof-sealed/src/main/java/org/openapitools/model/FruitType.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/spring-boot-oneof/src/main/java/org/openapitools/model/FruitType.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/EnumClass.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/model/OuterEnum.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/EnumClass.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/model/OuterEnum.java

@@ -2,6 +2,7 @@
 
 import java.net.URI;
 import java.util.Objects;
+import org.springframework.lang.Nullable;
 import com.fasterxml.jackson.annotation.JsonValue;
 import org.openapitools.jackson.nullable.JsonNullable;
 import java.time.OffsetDateTime;

samples/server/petstore/aspnetcore-3.0/src/Org.OpenAPITools/Controllers/FakeApi.cs

@@ -43,7 +43,7 @@ public virtual IActionResult FakeNullableExampleTest()
             //TODO: Uncomment the next line to return response 200 or use other options such as return this.NotFound(), return this.BadRequest(..), ...
             // return StatusCode(200, default);
             string exampleJson = null;
-            exampleJson = "{\n  \"nullableName\" : \"nullableName\",\n  \"name\" : \"name\"\n}";
+            exampleJson = "{\r\n  \"nullableName\" : \"nullableName\",\r\n  \"name\" : \"name\"\r\n}";
 
             var example = exampleJson != null
             ? JsonConvert.DeserializeObject<TestNullable>(exampleJson)