sc-oa 0.7.0.13__tar.gz → 0.7.0.15__tar.gz

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/.github/workflows/tests.yml

@@ -8,12 +8,12 @@ jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v1
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.11
 
       - name: Run pre-commit
         run: |
@@ -24,14 +24,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -47,12 +47,12 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v1
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: 3.11
 
       - name: Run sphinx
         run: |

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sc-oa
-Version: 0.7.0.13
+Version: 0.7.0.15
 Summary: Fork of the OpenAPI (fka Swagger) spec renderer for Sphinx
 Home-page: https://github.com/olivier-heurtier/sphinxcontrib-openapi/tree/mymaster
 Author: Ihor Kalnytskyi
@@ -20,15 +20,18 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Extension
 Requires-Python: >=3.8
 License-File: LICENSE
-Requires-Dist: sphinx<7.0
+Requires-Dist: sphinx
 Requires-Dist: sphinxcontrib-httpdomain
 Requires-Dist: PyYAML
 Requires-Dist: jsonschema
 Requires-Dist: m2r2
 Requires-Dist: picobox
 Requires-Dist: deepmerge
+Requires-Dist: setuptools
+Dynamic: license-file

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=45", "wheel", "setuptools_scm>=6.2"]
+requires = ["setuptools", "wheel", "setuptools_scm"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sc_oa.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sc-oa
-Version: 0.7.0.13
+Version: 0.7.0.15
 Summary: Fork of the OpenAPI (fka Swagger) spec renderer for Sphinx
 Home-page: https://github.com/olivier-heurtier/sphinxcontrib-openapi/tree/mymaster
 Author: Ihor Kalnytskyi
@@ -20,15 +20,18 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Framework :: Sphinx
 Classifier: Framework :: Sphinx :: Extension
 Requires-Python: >=3.8
 License-File: LICENSE
-Requires-Dist: sphinx<7.0
+Requires-Dist: sphinx
 Requires-Dist: sphinxcontrib-httpdomain
 Requires-Dist: PyYAML
 Requires-Dist: jsonschema
 Requires-Dist: m2r2
 Requires-Dist: picobox
 Requires-Dist: deepmerge
+Requires-Dist: setuptools
+Dynamic: license-file

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sc_oa.egg-info/SOURCES.txt

@@ -18,7 +18,6 @@ docs/specs/openapi.yml
 sc_oa.egg-info/PKG-INFO
 sc_oa.egg-info/SOURCES.txt
 sc_oa.egg-info/dependency_links.txt
-sc_oa.egg-info/namespace_packages.txt
 sc_oa.egg-info/not-zip-safe
 sc_oa.egg-info/requires.txt
 sc_oa.egg-info/top_level.txt

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sc_oa.egg-info/not-zip-safe

@@ -1 +1 @@
-
+

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sc_oa.egg-info/requires.txt

@@ -1,7 +1,8 @@
-sphinx<7.0
+sphinx
 sphinxcontrib-httpdomain
 PyYAML
 jsonschema
 m2r2
 picobox
 deepmerge
+setuptools

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/setup.cfg

@@ -20,6 +20,7 @@ classifiers =
 	Programming Language :: Python :: 3.9
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
+	Programming Language :: Python :: 3.12
 	Programming Language :: Python :: Implementation :: CPython
 	Framework :: Sphinx
 	Framework :: Sphinx :: Extension
@@ -30,18 +31,18 @@ build-dir = build/docs
 all_files = 1
 
 [options]
-packages = find:
+packages = sphinxcontrib
 include_package_data = True
 zip_safe = False
 install_requires = 
-	sphinx < 7.0
+	sphinx
 	sphinxcontrib-httpdomain
 	PyYAML
 	jsonschema
 	m2r2
 	picobox
 	deepmerge
-namespace_packages = sphinxcontrib
+	setuptools
 python_requires = >=3.8
 
 [egg_info]

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sphinxcontrib/__init__.py

@@ -8,5 +8,3 @@
     :copyright: (c) 2016 by Igor Kalnitsky.
     :license: BSD, see LICENSE for details.
 """
-
-__import__("pkg_resources").declare_namespace(__name__)

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sphinxcontrib/openapi/__init__.py

@@ -1,4 +1,4 @@
-"""
+"""get_distribution
     sphinxcontrib.openapi
     ---------------------
 
@@ -10,15 +10,15 @@
 """
 
 import os
-from pkg_resources import get_distribution, DistributionNotFound
+from importlib.metadata import distribution, PackageNotFoundError
 from sphinxcontrib.openapi import renderers, directive
 from sphinx.domains import Domain
 import yaml
 from docutils import nodes
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    __version__ = distribution(__name__).version
+except PackageNotFoundError:
     # package is not installed
     __version__ = None
 

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sphinxcontrib/openapi/openapi30.py

@@ -144,7 +144,8 @@ def _parse_schema(schema, method):
                             del example[k]
                 ret = collections.OrderedDict(example)
                 # XXX should be True to be compliant with OpenAPI
-                if schema.get('additionalProperties', False) and '...' not in example:
+                if (schema.get('additionalProperties', False) or 'type' not in schema) and \
+                        '...' not in example:
                     # materialize in the example the fact that additional properties can be added
                     ret['...'] = '...'
                 return ret
@@ -160,7 +161,7 @@ def _parse_schema(schema, method):
                 results.append((name, result))
 
         # XXX should be True to be compliant with OpenAPI
-        if schema.get('additionalProperties', False):
+        if schema.get('additionalProperties', False) or 'type' not in schema:
             # materialize in the example the fact that additional properties can be added
             results.append(("...", "..."))
 

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/sphinxcontrib/openapi/renderers/_model.py

@@ -245,9 +245,7 @@ def _process_one(prefix, schema, mandatory, entities, convert):
 
 
 def _build(name, schema, entities, convert, options):
-    if 'type' not in schema:
-        schema['type'] = 'object'
-    if schema.get('type', '') not in ['object', 'array']:
+    if 'type' in schema and schema['type'] not in ['object', 'array']:
         return ''
 
     yield ''
@@ -257,27 +255,32 @@ def _build(name, schema, entities, convert, options):
     yield options['header'] * len(name)
     yield ''
     D = _get_description(schema, convert)
+    if 'type' not in schema and not (set(['oneOf', 'allOf', 'anyOf']) & schema.keys()):
+        D += '\n' + _('Any type of content is accepted (number, string or object).')
     if D:
         yield D
         yield ''
-    yield '.. list-table:: ' + name
-    yield '    :header-rows: 1'
-    yield '    :widths: 25 25 45 15'
-    yield '    :class: longtable'
-    yield ''
-    yield '    * - ' + _('Attribute')
-    yield '      - ' + _('Type')
-    yield '      - ' + _('Description')
-    yield '      - ' + _('Required')
-
-    for item in _process_one([], schema, False, entities, convert):
-        if str(item[0]):
-            yield '    * - ``' + str(item[0]) + '``'
-        else:
-            yield '    * - ' + _('N/A')
-        yield '      - ' + textwrap.indent(str(item[1]), '        ').lstrip()
-        yield '      - ' + textwrap.indent(str(item[2]), '        ').lstrip()
-        yield '      - ' + _('Yes') if item[3] else '      -'
+    if 'type' not in schema and not (set(['oneOf', 'allOf', 'anyOf']) & schema.keys()):
+        pass
+    else:
+        yield '.. list-table:: ' + name
+        yield '    :header-rows: 1'
+        yield '    :widths: 25 25 45 15'
+        yield '    :class: longtable'
+        yield ''
+        yield '    * - ' + _('Attribute')
+        yield '      - ' + _('Type')
+        yield '      - ' + _('Description')
+        yield '      - ' + _('Required')
+
+        for item in _process_one([], schema, False, entities, convert):
+            if str(item[0]):
+                yield '    * - ``' + str(item[0]) + '``'
+            else:
+                yield '    * - ' + _('N/A')
+            yield '      - ' + textwrap.indent(str(item[1]), '        ').lstrip()
+            yield '      - ' + textwrap.indent(str(item[2]), '        ').lstrip()
+            yield '      - ' + _('Yes') if item[3] else '      -'
 
     if 'example' in schema or 'examples' in schema:
         N = 1
@@ -289,7 +292,8 @@ def _build(name, schema, entities, convert, options):
             N += 1
             # validate the example against this schema
             try:
-                validate(instance=ex, schema=schema)
+                if 'type' in schema:
+                    validate(instance=ex, schema=schema)
                 yield ''
                 yield '.. code-block:: json'
                 yield ''

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/tests/test_model.py

@@ -251,6 +251,46 @@ class TestOpenApi3Model(object):
               -
         """)
 
+    def test_no_type(self):
+        renderer = renderers.ModelRenderer(None, {})
+        spec = yaml.safe_load(textwrap.dedent("""
+        ---
+        openapi: 3.0.0
+        paths: {}
+        components:
+          schemas:
+            Test1:
+              description: This is a description
+              examples:
+                - field1: "test"
+                - "BUFFER"
+        """))
+        text = '\n'.join(renderer.render_restructuredtext_markup(spec))
+        assert text == textwrap.dedent("""
+        .. _/components/schemas/Test1:
+
+        Test1
+        '''''
+
+        This is a description
+        Any type of content is accepted (number, string or object).
+
+
+        Example #1:
+
+        .. code-block:: json
+
+            {
+              "field1": "test"
+            }
+
+        Example #2:
+
+        .. code-block:: json
+
+            "BUFFER"
+        """)
+
     def test_array(self):
         renderer = renderers.ModelRenderer(None, {})
         spec = yaml.safe_load(textwrap.dedent("""
@@ -1069,14 +1109,17 @@ class TestOpenApi3Model(object):
         components:
           schemas:
             A:
+              type: object
               properties:
                 a:
                   type: string
             B:
+              type: object
               properties:
                 b:
                   type: string
             AB:
+              type: object
               properties:
                 ab:
                   type: string

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/tests/test_openapi.py

@@ -2226,6 +2226,81 @@ class TestOpenApi3HttpDomain(object):
                 Success.
         ''').lstrip()
 
+    def test_entity_no_type(self):
+        renderer = renderers.HttpdomainOldRenderer(None, {'examples': True})
+        spec = yaml.safe_load(textwrap.dedent("""
+        ---
+        openapi: 3.0.0
+        servers:
+        - url: https://test.org/context
+        paths:
+          /resources:
+            post:
+              summary: Summary
+              description: test service
+              requestBody:
+                description: Body
+                content:
+                  application/json:
+                    schema:
+                      $ref: '#/components/schemas/Test1'
+              responses:
+                200:
+                  description: Success
+                  content:
+                    application/json:
+                      schema:
+                        $ref: '#/components/schemas/Test2'
+        components:
+          schemas:
+            Test1:
+              description: any type1
+              example:
+                field1: 12
+            Test2:
+              description: any type2
+        """))
+
+        text = '\n'.join(renderer.render_restructuredtext_markup(spec))
+        assert text == textwrap.dedent('''
+          .. http:post:: /resources
+             :synopsis: Summary
+
+             **Summary**
+
+             test service
+
+             :form body: Body.
+                any type1.
+
+             **Example request:**
+
+             .. sourcecode:: http
+
+                POST /resources HTTP/1.1
+                Host: example.com
+                Content-Type: application/json
+
+                {
+                    "field1": 12
+                }
+
+             :status 200:
+                Success.
+
+                **Example response:**
+
+                .. sourcecode:: http
+
+                   HTTP/1.1 200 OK
+                   Content-Type: application/json
+
+                   {
+                       "...": "..."
+                   }
+
+        ''').lstrip()
+
     def test_adv_parameters(self):
         renderer = renderers.HttpdomainOldRenderer(None, {'entities': True})
         spec = yaml.safe_load(textwrap.dedent("""

{sc-oa-0.7.0.13 → sc_oa-0.7.0.15}/tox.ini

@@ -7,6 +7,14 @@ deps =
     pytest
     responses
     Jinja2
+    sphinx
+    sphinxcontrib-httpdomain
+    PyYAML
+    jsonschema
+    m2r2
+    picobox
+    deepmerge
+    setuptools
 usedevelop = true
 commands =
     {envpython} -m pytest tests/ --strict-markers  {posargs}
@@ -19,6 +27,12 @@ commands =
 
 [testenv:docs]
 deps = sphinx_rtd_theme
+    sphinxcontrib-httpdomain
+    PyYAML
+    jsonschema
+    m2r2
+    picobox
+    deepmerge
 commands =
     sphinx-build -b html -d {envtmpdir}/doctrees docs docs/_build/
 

sc-oa-0.7.0.13/sc_oa.egg-info/namespace_packages.txt

@@ -1 +0,0 @@
-sphinxcontrib