openapi-generator icon indicating copy to clipboard operation
openapi-generator copied to clipboard

[REQ] General improvement of AsciiDoc generation

Open lfvjimisola opened this issue 3 years ago • 6 comments

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.

lfvjimisola avatar Jan 25 '22 13:01 lfvjimisola

EDIT: deleted grumble about passthrough of notation, which is related to https://github.com/OpenAPITools/openapi-generator/issues/9324

But... 👍 yes please, this general improvement would be very useful!

osfameron avatar Jun 13 '22 15:06 osfameron

It would be nice to expose to Mustache temlplates:

  • tags descriptions
  • security schemes descriptions

cpkio avatar Jul 29 '22 09:07 cpkio

It would be nice to expose to Mustache temlplates:

  • tags descriptions
  • security schemes descriptions

We are actually considering to leave Open API Tools and create our own jinja2 templates instead due to Open API Tools using Mustache which is logic less.

lfvjimisola avatar Aug 05 '22 06:08 lfvjimisola

Our work with our own jinja2 template for OpenAPI Spec to AsciiDoc using jinja2 has started. We are hoping to release it as open source.

lfvjimisola avatar Sep 07 '22 12:09 lfvjimisola