Skip to content

Conversation

@raouldh
Copy link
Contributor

@raouldh raouldh commented Nov 7, 2025

Fixes #12379
Add option useSwaggerV3Annotations for generating Swagger V3 Annotations to jaxrs-spec generator.
Default is false for useSwaggerV3Annotations.
When useSwaggerV3Annotations is set to true, the Swagger V2 annotation option(useSwaggerAnnotations) is automatically set to false.

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.

@wing328
Copy link
Member

wing328 commented Nov 9, 2025

thanks for the pr

let me know if this's ready for review

@raouldh raouldh marked this pull request as ready for review November 9, 2025 09:41
@raouldh
Copy link
Contributor Author

raouldh commented Nov 9, 2025

@wing328
This is ready for review.
Just tested a snapshot build on my projects where I need this. Generated code there seems fine as well as in the integration-tests.
This PR might also resolve a second issue(#14543), but I am not able to verify that.

@wing328
Copy link
Member

wing328 commented Nov 9, 2025

@raouldh thanks for the info and the details

@ziomill can you please review the fix when you've time?

@@ -0,0 +1,11 @@
generatorName: jaxrs-spec
outputDir: samples/server/petstore/jaxrs-spec-swagger-annotations
Copy link
Member

Choose a reason for hiding this comment

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

please add the folder to the CI: https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-jaxrs.yaml

so that it will be tested moved forward.

Copy link
Member

Choose a reason for hiding this comment

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

i'll do it in a separate pr. thanks for the contribution.

Copy link
Member

Choose a reason for hiding this comment

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

update: done via #22314

@wing328 wing328 added this to the 7.18.0 milestone Nov 10, 2025
@wing328 wing328 merged commit b1f2a67 into OpenAPITools:master Nov 10, 2025
33 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

oas3=true support for jaxrs-spec generator

2 participants