OpenAPITools / OpenAPITools/openapi-generator
[BUG] [Typescript] Error on undefined parameter
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?
- 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
With the new version, the encoding of the parameters completely changed, but there is an issue with the file
query.params.ts the function
function convertToString(value: any): string {
if (value instanceof Date) {
return value.toISOString();
} else {
return value.toString();
}
}
It's possible that an undefined value is passed to this function, resulting in an error
openapi-generator version
Open api version 7.18.0
Suggest a fix
Just protect the input of the function
function convertToString(value: any): string | undefined {
if (value === null || value === undefined) {
return undefined;
}
return value instanceof Date ? value.toISOString() : String(value);
}
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 by inspecting the generated query.params.ts file and the convertToString function described in the report. Verify how undefined parameters reach it and confirm the completed change avoids an error while preserving normal Date and string conversions; no specific test file is named in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100