Skip to content
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.

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

Update Spring example with jakarta validation dependency #16700

Closed
wants to merge 1 commit into from

Conversation

Philzen
Copy link
Contributor

@Philzen Philzen commented Oct 2, 2023

Spring Boot 2.2 switched many javax.*-packages to jakarta, as per

https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#jakarta-ee-dependencies

Changing the example POM to align with this change to avoid introducing two conflicting versions of the same namespace into a project.

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Spring Boot 2.2 switched many `javax.*`-packages to jakarta, as per 

https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#jakarta-ee-dependencies

Changing the example POM to align with this change to avoid introducing two conflicting versions of the same namespace into a project.
@Philzen Philzen requested a review from jimschubert as a code owner October 2, 2023 01:59
@Philzen
Copy link
Contributor Author

Philzen commented Oct 2, 2023

BTW – i realized https://github.com/OpenAPITools/openapi-generator/blob/v7.0.1/modules/openapi-generator-maven-plugin/examples/java-client.xml uses a newer version for swagger-annotations, namely 1.6.3 – while the spring example still uses 1.5.8.

1. Should this be harmonized as well?
2. What about 1.6.11 – which seems the most recent one from the 1.x branch – has that been tested for compatibility?

Oh dear, looks like they both need updates, pls see discussion for clarification in #16701

@Philzen
Copy link
Contributor Author

Philzen commented Oct 3, 2023

Could not test the springfox-swagger update as – so far – our projects don't need them, however from reading their documentation the 3.x version seems to be the way to go and is compatible with the Spring Boot Version in the examples: https://github.com/springfox/springfox#migrating-from-existing-2x-version

@wing328
Copy link
Member

wing328 commented Oct 4, 2023

I've merged #16720. Do you still need this?

happy to reopen this PR if needed

@wing328 wing328 closed this Oct 4, 2023
@Philzen
Copy link
Contributor Author

Philzen commented Oct 6, 2023

@wing328 Thanks! #16720 clarified a lot for me b/c i was already wondering whether

         <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

wouldn't be the better choice here – as it will transitively handle exactly the jakarta. vs. javax. confusion.

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