widdershins icon indicating copy to clipboard operation
widdershins copied to clipboard

openapi main.dot template not rendering description but title (in schema)

Open koh-osug opened this issue 5 years ago • 0 comments

Describe the bug

The description of a resource is ignored. When the MD is rendered the title is written, but the complete description is ignored.

The error results from the line:

{{? block.title }}*{{= block.title}}*{{= '\n\n'}}{{?}}

While it should be:

{{? block.description}}*{{= block.description}}*{{= '\n\n'}}{{?}}

Expected behavior

The description is rendered,

Versions:

  • Node.js (note only LTS versions are supported): 8.14.0

Additional context

Related to this problem is the rendering of properties which are links to other resources. Here a description is used:

{{~ block.rows :p}}|{{=p.displayName}}|{{=p.safeType}}|{{=p.required}}|{{=p.restrictions||'none'}}|{{=p.title||'none'}}|

This results for large description in an ugly huge multi line last column which is hard to read. Also this description is repeated in all resources using this resource. Here only a title should be seen.

koh-osug avatar Jun 26 '19 22:06 koh-osug