v3.0.0

[Chrimle]

What's Changed

New Features

• Remove javax/jakarta Annotations for @Nonnull/@Nullable by @Chrimle in Remove javax/jakarta Annotations for @Nonnull/@Nullable #487

  Removes @Nonnull and @Nullable annotations from generated record-classes. These annotations are no longer added to record-fields, nor to the canonical constructor-parameters. This allows these annotations, and subsequently their dependencies, to be completely optional. To keep these annotations, the x-field-extra-annotation-property must be set for each field.

Bug Fixes

• Remove serialVersionUID-field from Generated record Classes by @Chrimle in Remove serialVersionUID-field from Generated record Classes #488

  Removes the serialVersionUID-field from generated record classes, when the ConfigOption serializableModel is set to true. The field was removed due to overriding the default value, 1L instead of 0L, which could cause serialization issues, or was just redundant. As openapi-generator-maven-plugin provides no way to set the serialVersionUID, the Java-default value (0L) is a more appropriate value than the previous 1L. NOTE: this removes the serializableModel.mustache template!

• [webclient] Annotate record Constructor with @JsonCreator by @Chrimle in [webclient] Annotate record Constructor with @JsonCreator #491

  Annotates the canonical record Constructor with @JsonCreator, when the serializationLibrary is jackson (default for the webclient-library). This is an expected breaking bug-fix, as the canonical constructor will now be used when deserializing, instead of the compact constructor. This should allow fields to be assigned default values, done by the canonical constructor.

Dependency Updates

• Bump com.google.code.gson:gson from 2.13.0 to 2.13.1 by @dependabot[bot] in Bump com.google.code.gson:gson from 2.13.0 to 2.13.1 #443
• Bump org.apache.maven.plugins:maven-jar-plugin from 3.2.0 to 3.4.2 by @dependabot[bot] in Bump org.apache.maven.plugins:maven-jar-plugin from 3.2.0 to 3.4.2 #444
• Bump com.fasterxml.jackson.core:jackson-annotations from 2.18.3 to 2.19.0 by @dependabot[bot] in Bump com.fasterxml.jackson.core:jackson-annotations from 2.18.3 to 2.19.0 #440
• Bump org.openapitools:openapi-generator-maven-plugin from 7.12.0 to 7.13.0 by @dependabot[bot] in Bump org.openapitools:openapi-generator-maven-plugin from 7.12.0 to 7.13.0 #442
• Bump com.fasterxml.jackson.datatype:jackson-datatype-jsr310 from 2.18.3 to 2.19.0 by @dependabot[bot] in Bump com.fasterxml.jackson.datatype:jackson-datatype-jsr310 from 2.18.3 to 2.19.0 #446
• Bump spring-web.version from 6.2.6 to 6.2.7 by @dependabot[bot] in Bump spring-web.version from 6.2.6 to 6.2.7 #447
• Bump junit-jupiter.version from 5.12.2 to 5.13.0 by @dependabot[bot] in Bump junit-jupiter.version from 5.12.2 to 5.13.0 #449
• Bump com.diffplug.spotless:spotless-maven-plugin from 2.44.4 to 2.44.5 by @dependabot[bot] in Bump com.diffplug.spotless:spotless-maven-plugin from 2.44.4 to 2.44.5 #450
• Bump com.squareup.okio:okio from 3.11.0 to 3.12.0 by @dependabot[bot] in Bump com.squareup.okio:okio from 3.11.0 to 3.12.0 #451
• Bump junit-jupiter.version from 5.13.0 to 5.13.1 by @dependabot[bot] in Bump junit-jupiter.version from 5.13.0 to 5.13.1 #452
• Bump org.springframework:spring-web from 6.2.7 to 6.2.8 by @dependabot[bot] in Bump org.springframework:spring-web from 6.2.7 to 6.2.8 #453
• Bump org.sonatype.central:central-publishing-maven-plugin from 0.7.0 to 0.8.0 by @dependabot[bot] in Bump org.sonatype.central:central-publishing-maven-plugin from 0.7.0 to 0.8.0 #457
• Bump junit-jupiter.version from 5.13.1 to 5.13.2 by @dependabot[bot] in Bump junit-jupiter.version from 5.13.1 to 5.13.2 #459
• Bump org.openapitools:openapi-generator-maven-plugin from 7.13.0 to 7.14.0 by @dependabot[bot] in Bump org.openapitools:openapi-generator-maven-plugin from 7.13.0 to 7.14.0 #461
• Bump junit-jupiter.version from 5.13.2 to 5.13.3 by @dependabot[bot] in Bump junit-jupiter.version from 5.13.2 to 5.13.3 #465
• Bump com.diffplug.spotless:spotless-maven-plugin from 2.44.5 to 2.45.0 by @dependabot[bot] in Bump com.diffplug.spotless:spotless-maven-plugin from 2.44.5 to 2.45.0 #466
• Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.7 to 3.2.8 by @dependabot[bot] in Bump org.apache.maven.plugins:maven-gpg-plugin from 3.2.7 to 3.2.8 #471
• Bump junit-jupiter.version from 5.13.3 to 5.13.4 by @dependabot[bot] in Bump junit-jupiter.version from 5.13.3 to 5.13.4 #478
• Bump com.diffplug.spotless:spotless-maven-plugin from 2.45.0 to 3.0.0 by @dependabot[bot] in Bump com.diffplug.spotless:spotless-maven-plugin from 2.45.0 to 3.0.0 #481
• Inherit google-java-format Version from spotless-maven-plugin by @Chrimle in Inherit google-java-format Version from spotless-maven-plugin #483
• Bump junit-jupiter.version from 5.13.4 to 6.0.0 by @dependabot[bot] in Bump junit-jupiter.version from 5.13.4 to 6.0.0 #485

Full Changelog: v2.9.5...v3.0.0

---

This discussion was created from the release v3.0.0.

[Chrimle]

Rationale

This version contains 3 functional changes, all of which are breaking.

1. The main objective was to make the use of the webclient-library production-ready. While it could be argued that adding the @JsonCreator-annotation is simply a bug-fix, it is likely a breaking one.
2. As record classes do not need a serialVersionUID by default, and there is currently no possibility to configure it in openapi-generator, the field was removed to instead use the Java-default 0L. This is likely a breaking change for a very small few.
3. Removing the redundant @Nonnull/@Nullable annotations does make the classes less cluttered, while potentially sacrificing the conveying of explicit nullability. The reason for doing so, is that the x-field-extra-annotation-property would allow these annotations (among others) to be added on a field-by-field basis. This offers greatly more flexibility, while being less convenient if these annotations are desired.

This was the rationale for the release.

Other Changes

Since the last release, 30 PRs were merged. Majority of them were dependency updates.

Noteworthy changes

1. The mustache templates are now tested with multiple openapi-generator-maven-plugin versions for compatibility.
2. There is now a Security Policy.