OpenAPITools / OpenAPITools/openapi-generator
[BUG][TypeScript] Bug Any Type is mapped to an object data type in TypeScript
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
As per Swagger documentation for Any Type
{} is shorthand syntax for an arbitrary-type schema
openapi-generator-cli maps shorthand for any type {} to object data type when language is set to typescript-angular
openapi-generator version
7.9.0
It is not a regression.
OpenAPI declaration file content or url
Swagger file:
https://github.com/tmforum-apis/TMF620_ProductCatalog/blob/master/TMF620-ProductCatalog-v4.0.0.swagger.json
Please see excerpt for CharacteristicValueSpecification.value
"value": {
"$ref": "#/definitions/Any",
"description": "A discrete value that the characteristic can take on, or the actual value of the characteristic"
}
"Any": {},
Generation Details
Language: typescript-angular
Steps to reproduce
openapi-generator-cli generate -i https://raw.githubusercontent.com/tmforum-apis/TMF620_ProductCatalog/refs/heads/master/TMF620-ProductCatalog-v4.0.0.swagger.json -g typescript-angular -o ./openapi-generator-cli-TMF620_generated-typescript-models
$ grep "value?" ./openapi-generator-cli-TMF620_generated-typescript-models/model/characteristicValueSpecification.ts
value?: object;
Related issues/PRs
Suggest a fix
Below type could be used instead of object
type AnyValue = string | number | boolean | any[] | { [key: string]: any };
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 running the provided openapi-generator-cli command with the TMF620 specification and inspect the generated model/characteristicValueSpecification.ts file. Trace the typescript-angular generator's mapping for the empty Any schema, then verify that the generated value property uses the intended TypeScript representation rather than object.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100