Skip to content

[Java] Support Deprecation of Generated enum-classes #22312

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

Merged
merged 11 commits into from
Nov 12, 2025
Merged

[Java] Support Deprecation of Generated enum-classes #22312

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
ecbbccb
[Java] Annotate Deprecated `enum`-classes with `@Deprecated`
Chrimle Nov 9, 2025
f9db653
Update Generated 'samples'-files
Chrimle Nov 10, 2025
0461331
Merge branch 'OpenAPITools:master' into master
Chrimle Nov 10, 2025
a7696b8
Merge branch 'OpenAPITools:master' into master
Chrimle Nov 11, 2025
db8bb4f
Update `modelEnum.mustache` According to Review Comment
Chrimle Nov 11, 2025
313e355
Update Generated 'sample'-files
Chrimle Nov 11, 2025
8b6313a
Update Java Native `modelEnum.mustache` File
Chrimle Nov 11, 2025
e911f50
Update Java JaxRS `modelEnum.mustache` File
Chrimle Nov 11, 2025
349a2ab
Update Java Okhttp-gson `modelEnum.mustache` File
Chrimle Nov 11, 2025
837ced3
Update Java Micronaut `modelEnum.mustache` File
Chrimle Nov 11, 2025
19269c7
Update Java Helidon `modelEnum.mustache` File
Chrimle Nov 11, 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
3 changes: 2 additions & 1 deletion modules/openapi-generator/src/main/resources/Java/modelEnum.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ import java.util.Locale;
/**
* {{description}}{{^description}}Gets or Sets {{{name}}}{{/description}}
*/
{{#gson}}
{{#isDeprecated}}@Deprecated
Copy link
Member

@wing328 wing328 Nov 10, 2025

Choose a reason for hiding this comment

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

suggestion:

{{#isDeprecated}}
@Deprecated
{{/isDeprecated}}

Copy link
Contributor Author

@Chrimle Chrimle Nov 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This will result in an empty line, like:

/*
 * javadoc here...
 */
 
 @Deprecated

Also, making a newline between {{/isDeprecated}} and {{#gson}} will always generate another empty line after the deprecated-annotation, or result to 2 empty lines after the javadocs.

Is this OK? (from a Style-Guide perspective)?

Copy link
Contributor Author

@Chrimle Chrimle Nov 11, 2025

Choose a reason for hiding this comment

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

Hi @wing328, the suggested change has been done, and the updated samples have been committed too. 👍

{{/isDeprecated}}{{#gson}}
@JsonAdapter({{{datatypeWithEnum}}}{{^datatypeWithEnum}}{{{classname}}}{{/datatypeWithEnum}}.Adapter.class)
{{/gson}}
{{#jsonb}}
Expand Down