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
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
never supported as there was never a `/mk/v2/` namespace, intentionally).
- Fix [#35](https://github.com/Neoteroi/essentials-openapi/issues/35): group response
codes in a tab group on MkDocs output, reported by @Andre601.
- Fix [#47](https://github.com/Neoteroi/essentials-openapi/issues/47): remove `wordwrap`
filters from all templates as they break links and mermaid chart code blocks in
descriptions, reported by @ElementalWarrior.

## [1.3.0] - 2025-11-19

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
{%- for name, definition in components.responses.items() %}

### {{name}}
{% if definition.description %}{{definition.description | wordwrap(80)}}{% endif -%}
{% if definition.description %}{{definition.description}}{% endif -%}

{%- if definition.content -%}
{% with content = handler.simplify_content(definition.content) -%}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
```json
{{handler.write_content_example(example, content_type) | safe}}
```
{% if example.auto_generated %}_{{texts.auto_generated_example_note | wordwrap(80)}}_{% endif -%}
{% if example.auto_generated %}_{{texts.auto_generated_example_note}}_{% endif -%}
{% endif %}
{% endfor %}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## {{texts.external_docs}}

{% if externalDocs.description -%}
{{externalDocs.description | wordwrap(80)}}
{{externalDocs.description}}

---
{% endif -%}
Expand Down
2 changes: 1 addition & 1 deletion openapidocs/mk/v3/views_markdown/partial/info.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# {{info.title}} {{info.version}}

{% if info.description -%}
{{info.description | wordwrap(80)}}
{{info.description}}

---
{% endif -%}
Expand Down
4 changes: 2 additions & 2 deletions openapidocs/mk/v3/views_markdown/partial/path-items.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

### {{http_method.upper()}} {{path | safe}}
{% if "summary" in operation -%}
{{operation.summary | wordwrap(80)}}
{{operation.summary}}
{%- endif -%}

{%- if operation.description and operation.summary != operation.description %}

**{{texts.description.title()}}**
{{operation.description | wordwrap(80)}}
{{operation.description}}

{%- endif -%}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{% for name, definition in components.responses.items() %}

### {{name}}
{% if definition.description %}{{definition.description | wordwrap(80)}}{% endif %}
{% if definition.description %}{{definition.description}}{% endif %}

{%- if definition.content %}
{% with content = handler.simplify_content(definition.content) %}
Expand Down
2 changes: 1 addition & 1 deletion openapidocs/mk/v3/views_mkdocs/partial/external-docs.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## {{texts.external_docs}}

{% if externalDocs.description -%}
{{externalDocs.description | wordwrap(80)}}
{{externalDocs.description}}

<hr />
{%- endif -%}
Expand Down
2 changes: 1 addition & 1 deletion openapidocs/mk/v3/views_mkdocs/partial/info.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# {{info.title}} <span class="api-version">{{info.version}}</span>

{% if info.description -%}
{{info.description | wordwrap(80)}}
{{info.description}}
<hr />
{%- endif -%}

Expand Down
4 changes: 2 additions & 2 deletions openapidocs/mk/v3/views_mkdocs/partial/path-items.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@

### <span class="http-{{http_method.lower()}}">{{http_method.upper()}}</span> {{path | route | safe}}
{% if "summary" in operation -%}
{{operation.summary | wordwrap(80)}}
{{operation.summary}}
{%- endif -%}

{%- if operation.description and operation.summary != operation.description %}

??? note "{{texts.description.title()}}"
{{operation.description | wordwrap(76) | indent(4)}}
{{operation.description | indent(4)}}
{% endif %}

{%- with parameters = handler.get_parameters(operation) -%}
Expand Down
Loading