OpenAPITools / OpenAPITools/openapi-generator
[BUG] TypeScript generation changes property name
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? => See Description
- [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description
Hi, first of all, thank you for this wonderful tool :-)
My issue:
_
When generating a model for TypeScript, the variable/key "_" is not transformed correctly.
Example YAML Schema:
FooType:
required:
- _
type: object
properties:
_:
type: string
description: The FooType
discriminator:
propertyName: _
mapping:
Bar: '#/components/schemas/Bar'
Generated model in Typescript (actual):
export interface FooType {
_u: string;
}
Generated model in Typescript (expected):
export interface FooType {
_?: string;
}
What works:
_
When renaming the variable "_" to something like "property", the generated model is expected and working properly. However, due to
backwards-compatibility issues, we can't simply rename this variable.
openapi-generator version
openapi-generator-cli version => 5.1.1
Suggest a fix
Do not change the variable name? ;-)
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 with the supplied FooType OpenAPI schema and reproduce the generated TypeScript model in openapi-generator-cli 5.1.1. Trace the TypeScript generator's property-name handling for the underscore key and compare it with the working output for a renamed property. Done means the underscore remains unchanged and the generated model matches the expected optional property declaration, with a regression check for this schema.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100