OpenAPITools / OpenAPITools/openapi-generator
[BUG] typescrypt-axios generated api's response.data type is AxiosPromise<void>
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
Refer below example code:
const sendEmail = (data:openapi.EmailApiModel) =>{
const emailinput:openapi.EmailserviceModelInput = {}
emailinput.emaildata = data
const businesskey = "mykey"
let apiresult:openapi.EmailserviceModelOutput = {}
emailservice.emailservicePost(businesskey,emailinput).then((emailresult)=>{
apiresult = emailresult.data // error
})
}
The vscode can't allow me use the emailresult.data perfectly, I need to modify the generated code as below image

After above modification VSCode no more complaint.
openapi-generator version
I use openapi-generator-cli 6.5.0 (Mac)
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
Reproduce the issue by generating a TypeScript Axios client with openapi-generator-cli 6.5.0 and inspect the generated method's response type. Compare the declared response.data type with the endpoint's model output; done when the generated client exposes the expected response type without manual edits and the reproduction is covered by an appropriate generator test.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100