OpenAPITools / OpenAPITools/openapi-generator
[BUG] [javascript] generates wrong jsdoc annnotations
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
the generated file src/ApiClient.js contains this code:
/**
* The authentication methods to be included for all API calls.
* @type {Array.<String>}
*/
this.authentications = {
'Bearer': {type: 'apiKey', 'in': 'header', name: 'Authorization'}
}
Any good editor with jsdoc support will flag this as Object literal may only specify known properties, and ''Bearer'' does not exist in type 'string[]'.ts(2353), because the jsdoc says its an array of string, but it's assigned a map from string to objects.
A similar error occurs for defaultHeaders.
The jsdoc for callApi refers toa type ObjectFunction, which is not defined.
openapi-generator version
7.8.0
OpenAPI declaration file content or url
I don;t think it's relevant
Generation Details
using npm openapi-generator-cli generate -i ./openapi.json -g javascript -o ./generated
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 JavaScript client with openapi-generator-cli generate -i ./openapi.json -g javascript -o ./generated, then inspect the generated src/ApiClient.js. Check the JSDoc for authentications, defaultHeaders, and callApi; done means the annotations describe the assigned values and reference defined types without editor diagnostics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100