OpenAPITools / OpenAPITools/openapi-generator
[BUG] Description: typescript-node generator does not generate apiDoc
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
typescript documentation feature seems to be different than typescript-node. The former generates (.md) files for the RestAPI's whereas the latter does not whereas both generators seems to support apiDoc generation.
TypeScriptClientCodegen.java#L249
TypeScriptNodeClientCodegen.java#L66-L69
Can you please help with global property apiDoc generation feature using with typescript-node generator.
openapi-generator version
6.0.1
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
Compare TypeScriptClientCodegen.java around line 249 with TypeScriptNodeClientCodegen.java around lines 66-69, then review the typescript and typescript-node documentation-feature sections. Reproduce generation with the apiDoc global property using the reported OpenAPI Generator version or a current checkout. Done means typescript-node generates the expected REST API Markdown files like typescript does.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi, typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100