Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

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

## [1.3.0] - 2025-11-19

Expand Down
6 changes: 3 additions & 3 deletions openapidocs/mk/v3/views_markdown/partial/type.html
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{% if get_primary_type(definition.type) == "object" %}
{%- with props = handler.get_properties(definition) -%}
{% if props %}
| {{texts.name}} | {{texts.type}} |
| --- | --- |
| {{texts.name}} | {{texts.type}} | {{texts.description}} |
| --- | --- | --- |
{%- for name, schema in props %}
| {{name}} | {% include "partial/schema-repr.html" %} |
| {{name}} | {% include "partial/schema-repr.html" %} | {{schema.description}} |
{%- endfor -%}
{%- endif %}
{%- endwith -%}
Expand Down
2 changes: 2 additions & 0 deletions openapidocs/mk/v3/views_mkdocs/partial/type.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
<tr>
<th>{{texts.name}}</th>
<th>{{texts.type}}</th>
<th>{{texts.description}}</th>
</tr>
</thead>
<tbody>
{%- for name, schema in props %}
<tr>
<td><code>{{name}}</code></td>
<td>{% include "partial/schema-repr.html" %}</td>
<td>{{schema.description}}</td>
</tr>
{%- endfor %}
</tbody>
Expand Down
Loading