Skip to content

[FEAT][Java] Annotate Generated Enum-classes with @Generated#23863

Draft
Chrimle wants to merge 57 commits into
OpenAPITools:masterfrom
Chrimle:java-bug-annotate-enums-with-generated
Draft

[FEAT][Java] Annotate Generated Enum-classes with @Generated#23863
Chrimle wants to merge 57 commits into
OpenAPITools:masterfrom
Chrimle:java-bug-annotate-enums-with-generated

Conversation

@Chrimle
Copy link
Copy Markdown
Contributor

@Chrimle Chrimle commented May 24, 2026

Annotates generated enum-classes with @Generated - both inner and outer. Using ANY java-library. The @Generated-annotation will be imported dynamically based on the choice of Jakarta / JavaX. NOTE: While this is intended to be non-breaking, if this annotation is currently manually added (via configOptions or vendor-extensions), these MUST be removed because @Generated-annotations are NOT repeatable. This fixes #23832

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Adds @Generated to all generated Java enums (top-level and inner) so tools can recognize and ignore generated code. Aligns enums with other generated classes.

  • Bug Fixes

    • Inserted {{>generatedAnnotation}} before enum declarations across Java generators: microprofile, native, okhttp-gson, JavaInflector, JavaJaxRS (CXF, RESTEasy, Spec), JavaSpring, JavaPlayFramework, JavaVertXServer, java-helidon (client mp/se, server mp/se), java-msf4j-server, java-pkmst, java-undertow-server, java-micronaut; excludes java-vertx-web.
    • Emits javax.annotation.Generated or jakarta.annotation.Generated based on generator settings; adds a line break after the annotation.
    • Set hideGenerationTimestamp: true in sample generation configs and regenerated Java samples to include the annotation on all enums.
  • Migration

    • No action needed. If you manually add @Generated to enums, remove it to avoid duplicates; and for JDK 9+ with the javax variant, add javax.annotation:javax.annotation-api to the classpath.

Written for commit 340633f. Summary will update on new commits. Review in cubic

Chrimle added 30 commits May 24, 2026 01:21
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Chrimle added 3 commits May 24, 2026 02:16
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
private IntegerEnum integerEnum = IntegerEnum.NUMBER_1;
public enum StringEnumInlineEnum {
@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaJAXRSSpecServerCodegen", comments = "Generator version: 7.23.0-SNAPSHOT")
public enum StringEnumInlineEnum {
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Wrong indent. Happens to all these FakeTestsDefaultsDefaultResponse-classes. It likely stems from the {{>additionalEnumTypeAnnotations}} or {{>generatedAnnotation}} having different implementations in each library.....

Out-of-scope for the work being done here... We need to start merging these libraries together...

Chrimle added 14 commits May 24, 2026 02:35
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
@Chrimle Chrimle changed the title [BUG][Java] Annotate Generated Enum-classes with @Generated [FEAT][Java] Annotate Generated Enum-classes with @Generated May 24, 2026
@Chrimle
Copy link
Copy Markdown
Contributor Author

Chrimle commented May 24, 2026

4AM now, will continue tomorrow 😴

Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
@Chrimle
Copy link
Copy Markdown
Contributor Author

Chrimle commented May 24, 2026

I've noticed that generating samples fail silently 😢 So, will revert this for the failing generators, one-by-one...

Chrimle added 5 commits May 24, 2026 15:51
…ed`"

Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
@Chrimle
Copy link
Copy Markdown
Contributor Author

Chrimle commented May 24, 2026

petstore-helidon-server-se and petstore-helidon-server-se-uac both lack the jakarta dependency.

Not sure how to address this.

Signed-off-by: Chrimle <28791817+Chrimle@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[REQ] [Java] Add annotation Generated in Enum

1 participant