fix: display parameter description first instead of its schema descri…

…ption (#109)
asyncapi · Oct 22, 2020 · 959b31a · 959b31a
1 parent 05ab530
commit 959b31a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/partials/description.html b/partials/description.html
@@ -0,0 +1,5 @@
+{% macro getDescription(description) %}
+
+<div class="text-sm markdown">{{ description | markdown2html | safe }}</div>
+
+{% endmacro %}
diff --git a/partials/operation.html b/partials/operation.html
@@ -42,7 +42,7 @@ <h3 class="font-mono text-base">
           <div class="children bg-grey-lighter p-4 rounded">
             <div class="bg-grey-lightest pl-8 pr-8 rounded">
               {% for parameterName, parameter in channel.parameters() %}
-                {{ schemaProp(parameter.schema(), parameterName, odd=false, specialName=false, required=true) }}
+                {{ schemaProp(parameter.schema(), parameterName, odd=false, specialName=false, required=true, altDescription=parameter.description()) }}
               {% endfor %}
             </div>
           </div>

diff --git a/partials/schema-prop.html b/partials/schema-prop.html
@@ -1,7 +1,8 @@
 {% from "./type.html" import type %}
 {% from "./schema-item.html" import schemaItem %}
+{% from "./description.html" import getDescription %}
 
-{% macro schemaProp(prop, propName, open=false, root=false, odd=false, specialName=false, required=false, circularPropsParent) %}
+{% macro schemaProp(prop, propName, open=false, root=false, odd=false, specialName=false, required=false, altDescription=null, circularPropsParent) %}
 
 <div class="{% if odd %}bg-grey-lighter{% else %}bg-grey-lightest{% endif %} {% if not root %}pl-8 pr-8{% endif %} rounded">
   <div class="{% if open %}is-open{% endif %}">
@@ -80,9 +81,8 @@
           </div>
         </div>
 
-        {% if prop.description() %}
-          <div class="text-sm markdown">{{ prop.description() | markdown2html | safe }}</div>
-        {% endif %}
+        {{ getDescription(altDescription or prop.description()) }}
+
         {% if prop.default() !== undefined %}
           <div class="text-xs">Default: {{prop.default() | dump}}</div>
         {% endif %}