OpenAPITools / OpenAPITools/openapi-generator
Documentation does not mention ProjectName
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Description
I'm new to openapi generator. I want it to generate an api client for me. Since I'm using python a lot the first client to generate was python. I noticed early on that the generated client was named openapi-client. Then I spent more time than I'm willing to admit to configure the project name.
I started reading the generation templates and found out that I had to create a config.json containing "projectName": "theName". I didn't find this information anywhere in the documentation.
I think this should be explained somewhere early on because it creates a steep learning curve for new users.
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 generation templates and the documentation for configuring a Python client. Search for the config.json option projectName and document where users should set it and what it changes. The work is done when a new user can find and understand this configuration early in the client-generation documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100