Skip to content

[jaxrs-spec] Add @Generated annotation to enums#22829

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
amaechler:fix/jaxrs-spec-enum-generated-annotation
Jan 28, 2026
Merged

[jaxrs-spec] Add @Generated annotation to enums#22829
wing328 merged 2 commits intoOpenAPITools:masterfrom
amaechler:fix/jaxrs-spec-enum-generated-annotation

Conversation

@amaechler
Copy link
Copy Markdown
Contributor

@amaechler amaechler commented Jan 27, 2026

This PR adds a generated (@Generated) annotation to enum classes for the jaxrs-spec generator (A similar addition exists also for the Spring generator here.

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.

Related


Summary by cubic

Adds @generated to JAX-RS Spec–generated enum classes so tools can recognize generated code and reduce warning noise. Aligns JAX-RS Spec with the Spring generator behavior.

  • New Features
    • Added {{>generatedAnnotation}} to enumOuterClass.mustache to annotate all generated enums.
    • Emits javax.annotation.Generated or jakarta.annotation.Generated based on the variant.
    • Updated all jaxrs-spec petstore samples to include the annotation.

Written for commit 1098976. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 55 files

@wing328 wing328 merged commit 3db927e into OpenAPITools:master Jan 28, 2026
37 checks passed
@wing328 wing328 added this to the 7.20.0 milestone Jan 28, 2026
@amaechler amaechler deleted the fix/jaxrs-spec-enum-generated-annotation branch January 28, 2026 14:54
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.

2 participants