Skip to content

Conversation

@rignicat
Copy link
Contributor

Jackson was a requirement when using the server JAX-RS generator. Removing this requirement allows generating multi-platform code.

The PR is split into 3 commits (with a 4th for updating the samples/docs):

  1. Allow enabling/disabling jackson, since it was always enabled
  2. Disabled generating RootResource and RootApplication if generating interfaces, since these files make no sense in the context of generating interfaces
  3. Update templates to remove jackson references when disabled

The 2nd can be its own PR if required, since not directly relevant to the linked issue. But its a small change and something that makes no sense as it was, so I just added it instead of having to get a reviewer's attention twice.

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. - @martin-mfg Are you the correct person for this?

@wing328
Copy link
Member

wing328 commented Oct 18, 2025

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328
Copy link
Member

wing328 commented Oct 18, 2025

please also review the build failure when you've time

@rignicat rignicat force-pushed the remove-jackson-requirement branch from 5a04806 to e292bfb Compare October 20, 2025 07:07
@rignicat rignicat force-pushed the remove-jackson-requirement branch from e292bfb to f767c7b Compare October 20, 2025 07:44
@rignicat
Copy link
Contributor Author

rignicat commented Oct 20, 2025

@wing328 Done, re-added one import statement in the template that shouldn't have been removed.

convertPropertyToStringAndWriteBack(CodegenConstants.IMPL_FOLDER, this::setImplFolder);
convertPropertyToBooleanAndWriteBack(USE_BEANVALIDATION, this::setUseBeanValidation);
convertPropertyToBooleanAndWriteBack(USE_TAGS, this::setUseTags);
convertPropertyToBooleanAndWriteBack(JACKSON, this::setJackson);
Copy link
Member

Choose a reason for hiding this comment

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

what about defaulting this option to true instead?

(I can do it in another PR instead)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the value is set to default true here

I assumed the property, if not explicitly configured, would not be present (and this method does not set anything if the property is not present). Is this okay or is this an incrrect assumption?

Copy link
Member

Choose a reason for hiding this comment

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

I think you're right. I was not expecting so many changes to the samples if the option is default to true but it turns out most changes are just removing empty lines

i'll test the option locally and merge if no question from me.

@wing328
Copy link
Member

wing328 commented Oct 20, 2025

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @martin-mfg (2023/08)

@wing328
Copy link
Member

wing328 commented Oct 20, 2025

circleici failure (aws outage?) not related to this change

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.

2 participants