OpenAPITools / OpenAPITools/openapi-generator
[BUG] combining typeMappings with default can create broken Pojo artefact
Nobody has claimed this yet.
- 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
Consider the following Object definition in a swagger:
"OdbcConnection": {
"type": "object",
"properties": {
"ConnectionString": {
"type": "string",
"nullable": true
},
"ConnectionTimeout": {
"type": "integer",
"format": "int32",
"default": 15
}
},
"additionalProperties": false
}
We have a pattern where we try to work with longs so I configure my execution to translate all int to long:
<typeMappings>integer=Long,int=Long</typeMappings>
This works well, however in the rendered POJO I get a variable declaration for ConnectionTimeout that attempts to assign an int to a long which does not compile:
public static final String JSON_PROPERTY_CONNECTION_TIMEOUT = "ConnectionTimeout";
private Long connectionTimeout = 15;
If I manually modify the swagger to use int64 instead of int32 the 'l' character is appended to the default value correctly.
I believe the toDefaultValue method of the AbstractJavaCodegen needs an addition to account for this situation
openapi-generator version
OpenAPI declaration file content or url
Generation Details
Steps to reproduce
Related issues/PRs
Suggest a fix
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in AbstractJavaCodegen.toDefaultValue and reproduce the issue with the OdbcConnection schema and integer=Long,int=Long type mappings. Verify that the generated Java POJO handles the integer default correctly for the mapped Long field and remains compilable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100