OpenAPITools / OpenAPITools/openapi-generator
[REQ] Please provide example openapitools.[yaml/json] config files.
Open
Nobody has claimed this yet.
Enhancement: Feature
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
There is very little documentation on the formatting of the cli tool's config files. It would be great to get some, or at least examples.
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 locating the CLI configuration handling and any existing documentation for openapitools.yaml and openapitools.json. Add representative example configuration files and explain their formatting, with the documentation showing how users can use each format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100