OpenAPITools / OpenAPITools/openapi-generator
[REQ] Documentation for typescript-axios and typescript-fetch
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Relates to:: #2594
It's not clear how to use the generated api code, after generation. the Readme shows just how to install the package and that it is. the javascript client package is there more detailed and generates a lot of valuable 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 reviewing the generated README for the typescript-axios and typescript-fetch clients, then compare it with the more detailed JavaScript client documentation. Document how to use the generated API code after generation, covering the usage details missing from the current README. Done means both TypeScript client READMEs explain post-generation usage clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100