mnahkies / mnahkies/openapi-code-generator
Emit jsdoc based on descriptions, etc
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- TypeScript
- Stars
- 34
- Forks
- 8
- Avg merge
- 20h 27m
- Merged PRs (30d)
- 7
Description
Enhance developer experience by emitting jsdoc type comments using the documentation fields of the specification, to give richer information in the IDE about endpoint and fields
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
No files, tests, or entry points are named. Start by locating the generator entry point and templates that emit endpoint and field types, then trace how specification documentation fields are exposed. Done means generated TypeScript includes JSDoc for those endpoints and fields, with the generated output verified.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100