swagger-api / swagger-api/swagger-codegen-generators

useBeanValidation option results in deprecated API usage

Open
#1,337 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Mustache
Stars
299
Forks
439
PR merge metrics
No merged PRs in 30d

Description

When configuring useBeanValidation to true, generated classes seem to use deprecated attribute required from io.swagger.v3.oas.annotations.media.Schema.

@Schema(required = true, description = "")
public String getId() {
    return id;
}
required() in io.swagger.v3.oas.annotations.media.Schema has been deprecated

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 by locating the generator templates or entry points that handle the useBeanValidation option and emit @Schema(required = true). Check generated Java output and the Swagger Schema annotation API to identify the non-deprecated equivalent. Done means generated classes no longer use the deprecated required attribute when bean validation is enabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.