sc-oa 0.7.0.14__py3-none-any.whl → 0.7.0.16__py3-none-any.whl

{sc_oa-0.7.0.14.dist-info → sc_oa-0.7.0.16.dist-info}/METADATA

@@ -1,20 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sc-oa
-Version: 0.7.0.14
+Version: 0.7.0.16
 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
-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
-
-Olivier Heurtier
-Author-email: ihor@kalnytskyi.com
+Author: Olivier Heurtier
+Author-email: olivier.heurtier@github.com
 License: BSD
 Classifier: Topic :: Documentation
 Classifier: Topic :: Documentation :: Sphinx
@@ -43,3 +33,4 @@ Requires-Dist: m2r2
 Requires-Dist: picobox
 Requires-Dist: deepmerge
 Requires-Dist: setuptools
+Dynamic: license-file

{sc_oa-0.7.0.14.dist-info → sc_oa-0.7.0.16.dist-info}/RECORD

@@ -1,10 +1,11 @@
+sc_oa-0.7.0.16.dist-info/licenses/LICENSE,sha256=Fe9eBZy-tUN-UOMSVfcr4c-MWpuWa4gTKTqH-kSeck4,1319
 sphinxcontrib/__init__.py,sha256=Es10gRADmbGSJZnYYmhfgA_2QzHQDmhj0IAft3kS1Og,259
 sphinxcontrib/openapi/__init__.py,sha256=x8cvrnXGqjZSc62nkeZC0KdCcCSXQY8uxv1kFhrPM18,3088
 sphinxcontrib/openapi/__main__.py,sha256=cp8p7qGn8nH2W_aeD9sMTuqPwLV3ys8DtLYZnyF29pY,2436
 sphinxcontrib/openapi/_lib2to3.py,sha256=mU2Dx78xEyiz0cfcj3R9eqiwHbCfspK5cDJ5ZwwQdA4,13624
 sphinxcontrib/openapi/directive.py,sha256=J4T0n_KkM6SB1Mr9GeYCVqWZNp3BMSjEnVvLvwj8CoM,2059
 sphinxcontrib/openapi/openapi20.py,sha256=FDdlcRIYKCynOZUjxQNoE8lCFRrZinmYu1khz8D18ZU,8984
-sphinxcontrib/openapi/openapi30.py,sha256=HzFLza9Z3D7smDYfru0CPWLBK4dle5uuWZgNNqlFqtE,29056
+sphinxcontrib/openapi/openapi30.py,sha256=tW5pZoP-lR8ZUrwCsKDB_DXdOzoMdyYL1Irjd6mwdBM,29132
 sphinxcontrib/openapi/schema_utils.py,sha256=pxdB5qSTAtiCFmmF04R0zlOOG-Dxi98qwrA2uLZcNXA,4446
 sphinxcontrib/openapi/utils.py,sha256=oRWNDb_5KWTXOVblFgvrLvmGATae8C7PYvk1xc464vY,4343
 sphinxcontrib/openapi/locale/openapi.pot,sha256=sGo7dIRUUS6Ne4MRIU7PCphOoQG1AORgZhwwpD0nRfo,3831
@@ -16,11 +17,10 @@ sphinxcontrib/openapi/renderers/__init__.py,sha256=8hdY-sLK5kDbOL8Tqe55xEBphPFXV
 sphinxcontrib/openapi/renderers/_description.py,sha256=FAklhEaMksCYU5bno3SO0RuQCcwVTXbqPmPN3PrRlTM,702
 sphinxcontrib/openapi/renderers/_httpdomain.py,sha256=qx6pIVQF2BKWjrL1YOap1_2odtLAqk5SeuktofdOMRQ,24546
 sphinxcontrib/openapi/renderers/_httpdomain_old.py,sha256=aiWafD8LdRmCtG6ewkU3xF-P1oWxxYxUNzdcUFW4hB4,2632
-sphinxcontrib/openapi/renderers/_model.py,sha256=BapmKIHTXpS14huRUicz2rUxilaDau3uBOv-fsQ1mtE,15098
+sphinxcontrib/openapi/renderers/_model.py,sha256=yoU265jAgkiW_Ew4EFiWuzA8Q56AsmYa4HBODJDA2bw,15441
 sphinxcontrib/openapi/renderers/_toc.py,sha256=0cVLyKJBcu4ULkiBdlQ-oMBWV4DVCVM5-BgT07xG0Fc,1478
 sphinxcontrib/openapi/renderers/abc.py,sha256=-irO9yVoHeygaMieq4DZMmWD0B5DkDu2mKuenGYopTI,1485
-sc_oa-0.7.0.14.dist-info/LICENSE,sha256=Fe9eBZy-tUN-UOMSVfcr4c-MWpuWa4gTKTqH-kSeck4,1319
-sc_oa-0.7.0.14.dist-info/METADATA,sha256=0pId_xn_yRypsI3Xww4rGPLlWyZknxn9E0o1xC7f8b0,1551
-sc_oa-0.7.0.14.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-sc_oa-0.7.0.14.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
-sc_oa-0.7.0.14.dist-info/RECORD,,
+sc_oa-0.7.0.16.dist-info/METADATA,sha256=-slypLDLtwQjPS6hf10JVBTE1Fwic_tZUAmPrlV-ORM,1360
+sc_oa-0.7.0.16.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sc_oa-0.7.0.16.dist-info/top_level.txt,sha256=VJrV3_vaiKQVgVpR0I1iecxoO0drzGu-M0j40PVP2QQ,14
+sc_oa-0.7.0.16.dist-info/RECORD,,

{sc_oa-0.7.0.14.dist-info → sc_oa-0.7.0.16.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

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(("...", "..."))
 

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 ''