Workflow maintenance, fix #18, #19

Author: RobertoPrevato

.github/workflows/build.yml

@@ -16,11 +16,11 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7, 3.8, 3.9, "3.10"]
+        python-version: [3.8, 3.9, "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v1
@@ -29,7 +29,7 @@ jobs:
           submodules: false
 
       - name: Use Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -54,7 +54,7 @@ jobs:
             pip install -U --no-index --find-links=deps deps/*
           fi
 
-          pip install black==21.11b0 isort==5.10.1
+          pip install black isort
 
       - name: Run tests
         run: |
@@ -84,28 +84,28 @@ jobs:
 
       - name: Install distribution dependencies
         run: pip install --upgrade twine setuptools wheel
-        if: matrix.python-version == 3.8 || matrix.python-version == 3.9
+        if: matrix.python-version == 3.10
 
       - name: Create distribution package
         run: python setup.py sdist bdist_wheel
-        if: matrix.python-version == 3.8 || matrix.python-version == 3.9
+        if: matrix.python-version == 3.10
 
       - name: Upload distribution package
         uses: actions/upload-artifact@master
         with:
           name: dist-package-${{ matrix.python-version }}
           path: dist
-        if: matrix.python-version == 3.8 || matrix.python-version == 3.9
+        if: matrix.python-version == 3.10
 
   publish:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     needs: build
     if: github.event_name == 'release' || startsWith(github.ref, 'refs/tags/')
     steps:
       - name: Download a distribution artifact
         uses: actions/download-artifact@v2
         with:
-          name: dist-package-3.9
+          name: dist-package-3.10
           path: dist
       - name: Publish distribution 📦 to Test PyPI
         uses: pypa/gh-action-pypi-publish@master

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.4] - 2022-11-06 :snake:
+- Fixes [#18](https://github.com/Neoteroi/essentials-openapi/issues/18)
+- Workflow maintenance
+
 ## [1.0.3] - 2022-10-02
 - Changes how `httpx` version is pinned (`<1`)
 

openapidocs/__init__.py

@@ -1 +1 @@
-VERSION = "1.0.3"
+VERSION = "1.0.4"

openapidocs/mk/jinja.py

@@ -7,11 +7,13 @@
 
 from . import get_http_status_phrase, highlight_params, read_dict, sort_dict
 from .common import DocumentsWriter, is_reference
-from .md import write_table
+from .md import normalize_link, write_table
 
 
 def configure_filters(env: Environment):
-    env.filters.update({"route": highlight_params, "table": write_table})
+    env.filters.update(
+        {"route": highlight_params, "table": write_table, "link": normalize_link}
+    )
 
 
 def configure_functions(env: Environment):

openapidocs/mk/md.py

@@ -66,3 +66,9 @@ def write_table(
     Writes a Markdown table from a matrix (iterable of string records).
     """
     return "\n".join((write_table_lines(matrix, write_headers, padding)))
+
+
+def normalize_link(value: str) -> str:
+    if not value:
+        raise ValueError("Missing value")
+    return value.replace(".", "")

openapidocs/mk/v3/__init__.py

@@ -593,7 +593,8 @@ def get_properties(self, schema):
 
             if not schema:
                 return []
-        return [[key, value] for key, value in sort_dict(schema.get("properties"))]
+
+        return [[key, value] for key, value in sort_dict(schema.get("properties", {}))]
 
     def iter_schemas_bindings(self):
         """

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

@@ -1,12 +1,16 @@
 {% if definition.type == "object" %}
+{%- with props = handler.get_properties(definition) -%}
+{% if props %}
 | {{texts.name}} | {{texts.type}} |
 | -- | -- |
-{%- for name, schema in handler.get_properties(definition) %}
+{%- for name, schema in props %}
 | {{name}} | {% include "partial/schema-repr.html" %} |
 {%- endfor -%}
+{%- endif %}
+{%- endwith -%}
 {%- else -%}
 {%- with schema = definition -%}
-Type: 
+{{texts.type}}: 
 {%- include "partial/schema-repr.html" -%}
 {%- endwith -%}
 {%- endif %}

openapidocs/mk/v3/views_mkdocs/partial/request-responses.html

@@ -15,7 +15,7 @@
 </p>
 {%- if is_reference(definition) -%}
 {%- with type_name = definition["$ref"].replace("#/components/responses/", "") %}
-<div class="common-response"><p>Refer to the common response description: <a href="#{{type_name.lower()}}" class="ref-link">{{type_name}}</a>.</p></div>
+<div class="common-response"><p>Refer to the common response description: <a href="#{{type_name.lower() | link}}" class="ref-link">{{type_name}}</a>.</p></div>
 {%- endwith -%}
 {%- endif -%}
 {%- if definition.content %}

openapidocs/mk/v3/views_mkdocs/partial/schema-repr.html

@@ -1,6 +1,6 @@
 {%- if is_reference(schema) -%}
 {%- with type_name = schema["$ref"].replace("#/components/schemas/", "") -%}
-<a href="#{{type_name.lower()}}" class="ref-link">{{type_name}}</a>
+<a href="#{{type_name.lower() | link}}" class="ref-link">{{type_name}}</a>
 {%- endwith -%}
 {%- endif -%}
 

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

@@ -1,4 +1,6 @@
 {% if definition.type == "object" %}
+{%- with props = handler.get_properties(definition) -%}
+{% if props %}
 <table>
     <thead>
         <tr>
@@ -7,17 +9,19 @@
         </tr>
     </thead>
     <tbody>
-{%- for name, schema in handler.get_properties(definition) %}
+{%- for name, schema in props %}
         <tr>
             <td><code>{{name}}</code></td>
             <td>{% include "partial/schema-repr.html" %}</td>
         </tr>
         {%- endfor %}
     </tbody>
 </table>
+{%- endif %}
+{%- endwith -%}
 {%- else -%}
 {%- with schema = definition -%}
-<span>Type: </span>
+<span>{{texts.type}}: </span>
 {%- include "partial/schema-repr.html" -%}
 {%- endwith -%}
 {%- endif %}