OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA] --type-mappings for string+date are not working

Open
#16,891 4 comments 2 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 we specify --type-mappings string+date=LocalDate as CLI argument then it will generate invalid type for fields specified as:

type: string
format: date

It will generate private ModelLocalDate expiresOn; where ModelLocalDate does not exists

Update:
If I use --type-mappings string+date=Instant then it works. So it appears that maybe defining something what is default value will cause issues.

openapi-generator version

Tested this on:

  • 7.0.0, 7.0.1 - it does NOT work here
  • 6.6.0, 6.4.0 - it works here
OpenAPI declaration file content or url

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 Java generator CLI path and reproduce the provided OpenAPI schema using --type-mappings string+date=LocalDate on versions 7.0.0 or 7.0.1. Compare the generated model type with versions 6.6.0 or 6.4.0 and check the generator's existing type-mapping tests. Done means a string/date field generates LocalDate rather than the nonexistent ModelLocalDate type.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi
Domain
api, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.