Parameter description does not render in resulting output with html template

[derberg]

@maxs commented on Thu Mar 12 2020

In the folowing example description field won't be rendered in resulting output because it is not taken from the parameter toy but the schema. This means, to have description rendered, we would have to put description under schema block which is not intended behavior.

components:
  parameters:
    toy:
      description: Description of the toy
      schema:
        type: string

---

@github-actions[bot] commented on Thu Mar 12 2020

Welcome to AsyncAPI. Thanks a lot for reporting your first issue.

Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

---

@derberg commented on Thu Mar 12 2020

Some additional hint:
When I quickly look into the code of HTML template, the schemaProp macro https://github.com/asyncapi/generator/blob/master/templates/html/.partials/operation.html#L45 gets only the schema object. So the description that is used in the template https://github.com/asyncapi/generator/blob/master/templates/html/.partials/schema-prop.html#L76 is not taken from the parameter but the schema.

---

@github-actions[bot] commented on Wed May 13 2020

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

[derberg]

The logic that handles the rendering of information about Parameter is here and as you can see, it takes schema of the parameters and therefore displays only the description provided in the parameter. Maybe this macro needs to be extended?

[derberg]

video about the issue https://youtu.be/Iqs_2BiNEEo?t=677

[derberg]

@maxs this is fixed and released

[asyncapi-bot]

🎉 This issue has been resolved in version 0.15.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀