Skip to content
GitLab

JAX-RS Spec: Stop generating @NotNull Validation for required & optional properties

Merged Administrator requested to merge github/fork/wiesnery/patch-1 into master

Created by: wiesnery

Hi there,

I just realized a bug / missing feature in the JAX-RS Spec server stub generator. When providing a property which is required and readonly, it should according to the specification not be validated on request time. spec I used this combination for an id field, which is obviously not present upon posting a new entity but has to be present for reference in all further responses from the server.

I just adapted the code from the spring generator, as it works as expected: https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaSpring/beanValidation.mustache

You can find a similar issue with the Vert.X generator here: https://groups.google.com/g/vertx/c/CS5ZPIF8RgU?pli=1

Here you can find the results after the change (left side, the property is not required, : image

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/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 (6.0.1) (patch release), 6.1.x (breaking changes with fallbacks), 7.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. @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)