OpenAPITools / OpenAPITools/openapi-generator

[REQ] Disable TYPE_USE @Valid bean validation annotation

Open
#17,874 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

As of openapi-generator 7.2.0 the following code gets generated with the jaxrs-spec generator:

private @Valid List<@Valid Address> addresses;

In openapi-generator 7.1.0 this was:

private @Valid List<Address> addresses;

The @Valid annotation does not permit location TYPE_USE on Java EE 7 (bean-validation 1.1).
This is only possible since Java EE 8 (bean-validation 2.0).

Describe the solution you'd like

Option to disable TYPE_USE @Valid annotation, or to configure the bean-validation version to use.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the jaxrs-spec generator and compare its generated field output between openapi-generator 7.1.0 and 7.2.0. The work is done when users can disable TYPE_USE @Valid or configure the bean-validation version so Java EE 7-compatible output omits the nested annotation.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend-api-design, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.