OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA][SPRING] openapi-generator-maven-plugin can`t handle specs with nullable maps

Open
#9,741 0 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

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

When generating an API with the openapi-generator-maven-plugin based on Spring, an error occurs when using a nullable map in the API Spec.

#####OpenAPI Generator version

OpenAPI declaration file content or url
Generation Details
  • generator: openapi-generator-maven-plugin
  • version: 5.1.1
  • generatorName: spring
  • libary: spring boot
Steps to reproduce

I isolated the problem and created a simple example project: https://github.com/fweinhold/openapi-generator-spring-nullable-map-bug

The map creation in the generated put[Values] method is missing an enclosing Nullable.of().

Related issues/PRs
Suggest a fix

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 linked reproduction project and run its openapi-generator-maven-plugin setup using generatorName spring and version 5.1.1. Inspect the generated put[Values] method and compare its map creation with the nullable map behavior described in the issue. Done means nullable maps generate correctly without the reported error and the reproduction no longer shows the missing wrapper.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring, spring-boot
Domain
api, backend, build-system
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.