Remove @Valid even for enum types defined in components #18451

[wing328]

based on PR by @CREKD127

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
  

  (For Windows users, please run the script in Git BASH)
  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.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.

@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)

[CREKD127]

It looks like the requirements in issue can be met, but @Valid seems to be off even outside of the enum class.

[CREKD127]

link issue: #18430

[wing328]

It looks like the requirements in issue can be met, but @Valid seems to be off even outside of the enum class.

isEnum refers to inline enum

isEnumRef refers to enum class

use isEnumOrRef for both

[CREKD127]

I see, so is it more appropriate to fix it this way?

https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaJaxRS/spec/beanValidation.mustache
this file

{{#required}}{{^isReadOnly}}@NotNull {{/isReadOnly}}{{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnum}}@Valid {{/isEnum}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}}

fix to

{{#required}}{{^isReadOnly}}@NotNull {{/isReadOnly}}{{/required}}{{#isContainer}}{{^isPrimitiveType}}{{^isEnumOrRef}}@Valid {{/isEnumOrRef}}{{/isPrimitiveType}}{{/isContainer}}{{^isContainer}}{{^isPrimitiveType}}@Valid {{/isPrimitiveType}}{{/isContainer}}{{>beanValidationCore}}

[wing328]

no need for another PR. let me update it shortly

[wing328]

{{#isContainer}}{{^isPrimitiveType}}{{^isDate}}{{^isDateTime}}{{^isString}}{{^isFile}}{{^isEnumOrRef}}@Valid {{/isEnumOrRef}}{{/isFile}}{{/isString}}{{/isDateTime}}{{/isDate}}{{/isPrimitiveType}}{{/isContainer}}

let's try to simplify the logic here

can you tell me what type(s) need @Valid ?

[CREKD127]

The types I want to remove @Valid from are:

MyEnumClass: A class of type Enum that is not inline (as I mentioned in the issue, @Valid is not applied in the case of inline definitions. This behavior is preferred).
List<MyEnumClass>: A list of Enums.

[wing328]

what about other way around - what needs the @Valid annotation?

[CREKD127]

This action is an additional measure for the main issue at #14435. In my environment, the performance of the Hibernate Validator related to Enum values has significantly decreased. Therefore, I would like to implement measures only for Enum values in this case. At the moment, I have no other requests, such as wanting to add @Valid to other items.

[wing328]

I simply wanted to simplify the logic here a bit to make it easier to maintain moving forward. (not saying your approach/change is right or wrong)

[CREKD127]

I don't think @Valid is needed for PrimitiveType's (its wrapper types) List and Enum's List.

[CREKD127]

Is there any progress on this one? @wing328

[CREKD127]

I would like to see this implemented, what do you think?

I don't think @Valid is needed for PrimitiveType's (its wrapper types) List and Enum's List.

[CREKD127]

@wing328

[wing328]

when you've time this week, can you please PM me via Slack to further discuss this?

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g