Skip to content

[kotlin-spring][server] Fix: treat "nullable: false, required: false" attributes with "default" fallback value as non-nullable in DTOs #22258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
+2,196 −833
Open

[kotlin-spring][server] Fix: treat "nullable: false, required: false" attributes with "default" fallback value as non-nullable in DTOs #22258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
574db8c
attempts to make non required with default non-nullable
Picazsoo Oct 30, 2025
299cc80
add more complex cases to the open api definition
Picazsoo Oct 30, 2025
421b438
add java unit test
Picazsoo Oct 30, 2025
5d00c83
fix dataClass attribute formatting
Picazsoo Oct 30, 2025
e837d3e
add updated files
Picazsoo Oct 30, 2025
00f079c
add some default strings and fix test
Picazsoo Oct 30, 2025
6159bca
add some default strings and fix test
Picazsoo Oct 31, 2025
611eb87
fix open api definition to side-step issues with local enum schema de…
Picazsoo Oct 31, 2025
1019573
add a case with nullable attribute with non-null default. That breaks…
Picazsoo Oct 31, 2025
6428dde
fix behavior for nullable with null and non-null default
Picazsoo Oct 31, 2025
c9f57fc
regenerate code
Picazsoo Oct 31, 2025
4993124
revert unrelated formatting changes in test
Picazsoo Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions modules/openapi-generator/src/main/resources/kotlin-spring/dataClass.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@
}}{{/serializableModel}}{{! no newline
}}{{/parent}} {
{{#discriminator}}
{{#requiredVars}}
{{>interfaceReqVar}}{{! prevent indent}}
{{/requiredVars}}
{{#optionalVars}}
{{>interfaceOptVar}}{{! prevent indent}}
{{/optionalVars}}
{{#requiredVars}}
{{>interfaceReqVar}}{{! prevent indent}}
{{/requiredVars}}
{{#optionalVars}}
{{>interfaceOptVar}}{{! prevent indent}}
{{/optionalVars}}
{{/discriminator}}
{{#hasEnums}}{{#vars}}{{#isEnum}}
/**
Expand Down
30 changes: 24 additions & 6 deletions modules/openapi-generator/src/main/resources/kotlin-spring/dataClassOptVar.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,24 @@
{{#useBeanValidation}}{{>beanValidation}}{{>beanValidationModel}}{{/useBeanValidation}}{{#swagger2AnnotationLibrary}}
@Schema({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
@ApiModelProperty({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{/swagger1AnnotationLibrary}}{{#deprecated}}
@Deprecated(message = ""){{/deprecated}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{/vendorExtensions.x-field-extra-annotation}}
@get:JsonProperty("{{{baseName}}}"){{#isInherited}} override{{/isInherited}} {{>modelMutable}} {{{name}}}: {{#isEnum}}{{#isArray}}{{baseType}}<{{/isArray}}{{classname}}.{{{nameInPascalCase}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}? = {{^defaultValue}}null{{/defaultValue}}{{#defaultValue}}{{^isNumber}}{{{defaultValue}}}{{/isNumber}}{{#isNumber}}{{{dataType}}}("{{{defaultValue}}}"){{/isNumber}}{{/defaultValue}}
{{! comments are used to break long lines into multiple lines for better readability }}
{{#useBeanValidation}}{{>beanValidation}}{{>beanValidationModel}}{{/useBeanValidation}}{{!
}}{{#swagger2AnnotationLibrary}}
Comment on lines +1 to +3
Copy link
Contributor Author

@Picazsoo Picazsoo Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am using these dummy multi-line comments as a way to make the long lines more readable.

@Schema({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}required = false, {{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{!
}}{{/swagger2AnnotationLibrary}}{{!
}}{{#swagger1AnnotationLibrary}}
@ApiModelProperty({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}required = false, {{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{!
}}{{/swagger1AnnotationLibrary}}{{!
}}{{#deprecated}}
@Deprecated(message = ""){{!
}}{{/deprecated}}{{!
}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{!
}}{{/vendorExtensions.x-field-extra-annotation}}
@get:JsonProperty("{{{baseName}}}", required = false)
{{#isInherited}}{{!
}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{!
}}{{#isEnum}}{{#isArray}}{{baseType}}<{{/isArray}}{{classname}}.{{{nameInPascalCase}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{!
}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{!
}}{{^defaultValue}}? = null{{/defaultValue}}{{!
}}{{#defaultValue}}{{#isNullable}}?{{/isNullable}} = {{!
}}{{^isNumber}}{{{defaultValue}}}{{/isNumber}}{{!
}}{{#isNumber}}{{{dataType}}}("{{{defaultValue}}}"){{/isNumber}}{{!
}}{{/defaultValue}}
26 changes: 21 additions & 5 deletions modules/openapi-generator/src/main/resources/kotlin-spring/dataClassReqVar.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
{{#useBeanValidation}}{{>beanValidation}}{{>beanValidationModel}}{{/useBeanValidation}}{{#swagger2AnnotationLibrary}}
@Schema({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}required = true, {{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
@ApiModelProperty({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}required = true, {{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{/swagger1AnnotationLibrary}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{/vendorExtensions.x-field-extra-annotation}}
@get:JsonProperty("{{{baseName}}}", required = true){{#isInherited}} override{{/isInherited}} {{>modelMutable}} {{{name}}}: {{#isEnum}}{{#isArray}}{{baseType}}<{{/isArray}}{{classname}}.{{{nameInPascalCase}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{#isNullable}}?{{/isNullable}}{{#defaultValue}} = {{^isNumber}}{{{defaultValue}}}{{/isNumber}}{{#isNumber}}{{{dataType}}}("{{{defaultValue}}}"){{/isNumber}}{{/defaultValue}}
{{! comments are used to break long lines into multiple lines for better readability }}
{{#useBeanValidation}}{{>beanValidation}}{{>beanValidationModel}}{{/useBeanValidation}}{{!
}}{{#swagger2AnnotationLibrary}}
@Schema({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}required = true, {{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{!
}}{{/swagger2AnnotationLibrary}}{{!
}}{{#swagger1AnnotationLibrary}}
@ApiModelProperty({{#example}}example = "{{#lambdaRemoveLineBreak}}{{#lambdaEscapeInNormalString}}{{{.}}}{{/lambdaEscapeInNormalString}}{{/lambdaRemoveLineBreak}}", {{/example}}required = true, {{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{!
}}{{/swagger1AnnotationLibrary}}{{!
}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{!
}}{{/vendorExtensions.x-field-extra-annotation}}
@get:JsonProperty("{{{baseName}}}", required = true)
{{#isInherited}}{{!
}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{!
}}{{#isEnum}}{{#isArray}}{{baseType}}<{{/isArray}}{{classname}}.{{{nameInPascalCase}}}{{#isArray}}>{{/isArray}}{{/isEnum}}{{!
}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{!
}}{{#isNullable}}?{{/isNullable}}{{!
}}{{#defaultValue}} = {{!
}}{{^isNumber}}{{{defaultValue}}}{{/isNumber}}{{!
}}{{#isNumber}}{{{dataType}}}("{{{defaultValue}}}"){{/isNumber}}{{!
}}{{/defaultValue}}
25 changes: 21 additions & 4 deletions modules/openapi-generator/src/main/resources/kotlin-spring/interfaceOptVar.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
{{! comments are used to break long lines into multiple lines for better readability }}
{{#swagger2AnnotationLibrary}}
@get:Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}requiredMode = Schema.RequiredMode.REQUIRED, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
@get:ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{/swagger1AnnotationLibrary}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{/vendorExtensions.x-field-extra-annotation}}
{{#isInherited}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{#isEnum}}{{classname}}.{{nameInPascalCase}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}? {{^discriminator}}= {{{defaultValue}}}{{^defaultValue}}null{{/defaultValue}}{{/discriminator}}
@get:Schema({{#example}}example = "{{{.}}}", {{/example}}{{!
}}{{#required}}requiredMode = Schema.RequiredMode.REQUIRED, {{/required}}{{!
}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}{{!
}}description = "{{{description}}}"){{!
}}{{/swagger2AnnotationLibrary}}{{!
}}{{#swagger1AnnotationLibrary}}
@get:ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{!
}}{{#required}}required = {{required}}, {{/required}}{{!
}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}{{!
}}value = "{{{description}}}"){{!
}}{{/swagger1AnnotationLibrary}}{{!
}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{!
}}{{/vendorExtensions.x-field-extra-annotation}}
{{#isInherited}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{!
}}{{#isEnum}}{{classname}}.{{nameInPascalCase}}{{/isEnum}}{{!
}}{{^isEnum}}{{{dataType}}}{{/isEnum}}{{!
}}{{#isNullable}}?{{/isNullable}}{{!
}}{{^isNullable}}{{^defaultValue}}?{{/defaultValue}}{{/isNullable}}{{!
}}{{^discriminator}} = {{{defaultValue}}}{{^defaultValue}}null{{/defaultValue}}{{/discriminator}}
22 changes: 18 additions & 4 deletions modules/openapi-generator/src/main/resources/kotlin-spring/interfaceReqVar.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
{{! comments are used to break long lines into multiple lines for better readability }}
{{#swagger2AnnotationLibrary}}
@get:Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}requiredMode = Schema.RequiredMode.REQUIRED, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}description = "{{{description}}}"){{/swagger2AnnotationLibrary}}{{#swagger1AnnotationLibrary}}
@get:ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}value = "{{{description}}}"){{/swagger1AnnotationLibrary}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{/vendorExtensions.x-field-extra-annotation}}
{{#isInherited}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{#isEnum}}{{classname}}.{{nameInPascalCase}}{{/isEnum}}{{^isEnum}}{{{dataType}}}{{/isEnum}}
@get:Schema({{#example}}example = "{{{.}}}", {{/example}}{{!
}}{{#required}}requiredMode = Schema.RequiredMode.REQUIRED, {{/required}}{{!
}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}{{!
}}description = "{{{description}}}"){{!
}}{{/swagger2AnnotationLibrary}}{{!
}}{{#swagger1AnnotationLibrary}}
@get:ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{!
}}{{#required}}required = {{required}}, {{/required}}{{!
}}{{#isReadOnly}}readOnly = {{{isReadOnly}}}, {{/isReadOnly}}{{!
}}value = "{{{description}}}"){{!
}}{{/swagger1AnnotationLibrary}}{{!
}}{{#vendorExtensions.x-field-extra-annotation}}
{{{.}}}{{!
}}{{/vendorExtensions.x-field-extra-annotation}}
{{#isInherited}}override {{/isInherited}}{{>modelMutable}} {{{name}}}: {{!
}}{{#isEnum}}{{classname}}.{{nameInPascalCase}}{{/isEnum}}{{!
}}{{^isEnum}}{{{dataType}}}{{/isEnum}}
Loading
Loading