OpenAPITools / OpenAPITools/openapi-generator
[REQ] Documentation on how to use generated SDKs
Open
Nobody has claimed this yet.
Enhancement: Feature
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
While the number of supported languages and target libaries is impressive, there's no documentation on how to actually use SDKs once they're generated. This makes for a lot of trial/error and guesswork.
How is someone supposed to know how to use whatever the generator outputs?
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
The issue does not identify a documentation file, test, or entry point, so first map where generated SDK usage guidance belongs across the project. Done means providing practical instructions for using generated SDKs, reducing the trial and error described in the issue.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100