2.2.29 do not treat @NotBlank as mandatory, breaking change?

[rikardhaggkvist]

In previous versions

public class Bar {
@NotBlank
private String foo;
}

generated to

export interface Bar {
  foo: string;
}

in 2.2.29 @NotBlank is generated to:

export interface Bar {
  foo?: string;
}

which in turn breaks the TypeSript code with error "Type 'string | undefined' is not assignable to type 'string'."

Now I need to add @NotNull to all the @NotBlank annotations in my Java code, it seems to apply to @NotEmpty also.

[ponelat]

Hi @rikardhaggkvist
@notblank shouldn't impact the required/not-required types generated in TypeScript, could be related to a regression.
Would you mind sharing the OpenAPI file that's generated as an intermediate, to show if it's in the generator or the swagger-core that the issue lies in?

[rikardhaggkvist]

pom.xml

<plugin>
                <groupId>io.swagger.core.v3</groupId>
                <artifactId>swagger-maven-plugin-jakarta</artifactId>
                <version>2.2.29</version>
                <configuration>
                    <outputFileName>api</outputFileName>
                    <outputPath>${basedir}/target</outputPath>
                    <outputFormat>JSONANDYAML</outputFormat>
                    <resourcePackages>
                        <resourcePackage>bar.foo.service.api.rest</resourcePackage>
                    </resourcePackages>
                    <prettyPrint>true</prettyPrint>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>resolve</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

With @NotNull and @NotBlank api.json looks like:

      "MyClass" : {
        "required" : [ "myProp" ],
        "type" : "object",
        "properties" : {
          "myProp" : {
            "minLength" : 1,
            "type" : "string"
          },

If I remove @NotNull api.json looks like:

      "MyClass" : {
        "type" : "object",
        "properties" : {
          "myProp" : {
            "minLength" : 1,
            "type" : "string"
          },

If I now switch to swagger 2.2.28, not other changes and only got @NotBlank, api.json looks like:

      "MyClass" : {
        "required" : [ "myProp" ],
        "type" : "object",
        "properties" : {
          "myProp" : {
            "type" : "string"
          },

If I switch back to 2.2.29, no other changes:

      "MyClass" : {
        "type" : "object",
        "properties" : {
          "myProp" : {
            "minLength" : 1,
            "type" : "string"
          },

So for me it's obvious the behaviour changed in 2.2.29. @NotBlank and @NotEmpty are no longer required properties in the genereated apis. This should be mentioned in the release notes or be considered as a breaking change.

[OlliL]

@NotEmpty as well as @NotBlank JavaDoc clearly states "The annotated element must not be null and ..." - so I'd say its not just a breaking change, its a bug which needs to be fixed because "must not be null" translates in my understanding to required

minLength and required are separate constraints. minLength means that if a string value is provided, its length must be minLength or more.

So - not providing a string which has minLength set but not required is fine whereas @NotEmpty requires it to be non-null!

[aconrad]

Would you mind sharing the OpenAPI file that's generated as an intermediate, to show if it's in the generator or the swagger-core that the issue lies in?

I consume the API in JSON and here is the diff before/after the bug. I used javax.validation.constraints.NotNull to annotate fields as required.

             ],
             "type": "string"
           }
-        },
-        "required": [
-          "make",
-          "model"
-        ]
+        }
       },
       "Phone": {
         "properties": {

[aconrad]

Using import jakarta.validation.constraints.NotNull; instead of import javax.validation.constraints.NotNull; works as expected for me. Something definitely broke but could be a workaround for those of you out there hitting the same issue as I do.

[ThomHurks]

Our projects are also affected, as we use @NotEmpty and @NotBlank to indicate if something is required, as both annotations imply non-null. Our workaround was also to roll back to 2.2.28 temporarily.

[fleboulch]

Impacted also on my projects since 2.2.29 version on @NotEmpty and @NotBlank

[Chasson1992]

Our projects are also affected, as we use @NotEmpty and @NotBlank to indicate if something is required, as both annotations imply non-null. Our workaround was also to roll back to 2.2.28 temporarily.

Also impacting our project. Used the same workaround as @ThomHurks

[frantuma]

Thanks all for reporting and investigating this, fixed in #4870