OpenAPITools / OpenAPITools/openapi-generator
[REQ][typescript-axios] Full documentation for apis and models
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
The typescript-axios generator, along with other ts generators, lacks of all the generation of the documentation, most of all the others generators (javascript, php, java and many more) generate a docs folder, containing all the necessary informations for every method and model.
Describe the solution you'd like
The addition of this feature I think is key and shouldn't be very difficult to implement as it's very similar to the javascript (with promises) documentation.
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 comparing the typescript-axios generator with the JavaScript generator's documentation output, especially the generated docs folder for API methods and models. Trace the typescript-axios templates and generation flow, then verify that generated clients include equivalent API and model documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100