OpenAPITools / OpenAPITools/openapi-generator
[REQ] appDescription for Ruby?
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.
I'd like the ability to have a customized section in my README, but still keep generated code on the README page.
Describe the solution you'd like
I'd like to see appDescription get used, which AFAIK isn't used on the Ruby README files.
Describe alternatives you've considered
Alternatives may be ignore the README and customizing it for my needs, but I'd lose out on the generated aspect by doing that.
Additional context
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 Ruby README templates and the existing handling of appDescription in the generator. Check how Ruby README files are generated, then confirm that a customized section is preserved alongside generated content. The issue mentions no specific files or tests, so completion criteria should be clarified before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, ruby
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100