Skip to content

Commit 88f230a

Browse files
Fix #45 (#66)
1 parent b463230 commit 88f230a

File tree

8 files changed

+427
-185
lines changed

8 files changed

+427
-185
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
- Add OAS 3.1 support, cross-version warnings, and fix nullable spacing, by @dcode.
1111
- Fix MARKDOWN style table separators to use minimum 3 hyphens (issue #39), reported by @michael-nok.
12+
- Fix [#45](https://github.com/Neoteroi/essentials-openapi/issues/45): add support for displaying descriptions of schema properties, reported by @Maia-Everett.
1213

1314
## [1.3.0] - 2025-11-19
1415

openapidocs/mk/v3/views_markdown/partial/type.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{% if get_primary_type(definition.type) == "object" %}
22
{%- with props = handler.get_properties(definition) -%}
33
{% if props %}
4-
| {{texts.name}} | {{texts.type}} |
5-
| --- | --- |
4+
| {{texts.name}} | {{texts.type}} | {{texts.description}} |
5+
| --- | --- | --- |
66
{%- for name, schema in props %}
7-
| {{name}} | {% include "partial/schema-repr.html" %} |
7+
| {{name}} | {% include "partial/schema-repr.html" %} | {{schema.description}} |
88
{%- endfor -%}
99
{%- endif %}
1010
{%- endwith -%}

openapidocs/mk/v3/views_mkdocs/partial/type.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@
66
<tr>
77
<th>{{texts.name}}</th>
88
<th>{{texts.type}}</th>
9+
<th>{{texts.description}}</th>
910
</tr>
1011
</thead>
1112
<tbody>
1213
{%- for name, schema in props %}
1314
<tr>
1415
<td><code>{{name}}</code></td>
1516
<td>{% include "partial/schema-repr.html" %}</td>
17+
<td>{{schema.description}}</td>
1618
</tr>
1719
{%- endfor %}
1820
</tbody>

0 commit comments

Comments
 (0)