OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA][SPRING] "required" information is lost in combination with inheritance (allOf)

Open
#5,212 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Description

When a type is inherited and extended with additional properties, the properties can not declared as "required". The YAML is valid and the Swagger-Editor and Swagger-UI shows the properties as required, but the generator doen't generate @NotNull. The verbose output shows the property, but "required" is displayed as "false".

This is the case, when "required" is declared after "properties". When "required" is declared before "properties", it is even more worst, in this case the properties are completely missing... Both YAMLs are valid.

openapi-generator version

4.2.2

OpenAPI declaration file content or url

attached

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 attached OpenAPI declaration and verbose generator output, then trace how allOf inheritance is handled by the Java Spring generator. Reproduce both required-before-properties and required-after-properties cases; done means inherited required properties remain present and generate @NotNull annotations.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.