OpenAPITools / OpenAPITools/openapi-generator
[REQ] General improvement of AsciiDoc generation
Open
Nobody has claimed this yet.
Enhancement: Feature
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
The generated AsciiDoc output is not complete if you compare it to standard swagger.ui (e.g Petstore). Missing things are e.g.
- property restrictions (maxLength, minLength, etc): #11389
- schemas seems to be missing as well
- appDescription: #7851
- invalid value for "example" field: #5710
and other such as
- convert markdown into asciidoc #7765
Describe the solution you'd like
Update mustaché templates to output more of the information in OpenAPI spec file when generating AsciiDoc.
Describe alternatives you've considered
None other than completely manual writing.
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 with the Mustache templates responsible for AsciiDoc generation and compare their output for the linked Petstore example with standard swagger.ui. Review the listed gaps and linked issues, then define which OpenAPI fields are covered and verify that generated AsciiDoc includes the agreed information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100