python-openapi/openapi-core#296: Implements OpenAPI 3.1 validator

Author: nezhar

.github/workflows/python-test.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7, 3.8, 3.9]
+        python-version: [3.6, 3.7, 3.8, 3.9]
       fail-fast: false
     steps:
     - uses: actions/checkout@v2

README.rst

@@ -18,7 +18,10 @@ openapi-schema-validator
 About
 #####
 
-Openapi-schema-validator is a Python library that validates schema against the `OpenAPI Schema Specification v3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject>`__ which is an extended subset of the `JSON Schema Specification Wright Draft 00 <http://json-schema.org/>`__.
+Openapi-schema-validator is a Python library that validates schema against:
+
+* `OpenAPI Schema Specification v3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#schemaObject>`__ which is an extended subset of the `JSON Schema Specification Wright Draft 00 <http://json-schema.org/>`__.
+* `OpenAPI Schema Specification v3.1 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#schemaObject>`__ which is an extended superset of the `JSON Schema Specification Draft 2020-12 <http://json-schema.org/>`__.
 
 Installation
 ############
@@ -47,7 +50,7 @@ Simple usage
 
    # A sample schema
    schema = {
-       "type" : "object",
+       "type": "object",
        "required": [
           "name"
        ],
@@ -82,9 +85,9 @@ You can also check format for primitive types
 
 .. code-block:: python
 
-   from openapi_schema_validator import oas30_format_checker
+   from openapi_schema_validator import oas31_format_checker
 
-   validate({"name": "John", "birth-date": "-12"}, schema, format_checker=oas30_format_checker)
+   validate({"name": "John", "birth-date": "-12"}, schema, format_checker=oas31_format_checker)
 
    Traceback (most recent call last):
        ...

openapi_schema_validator/__init__.py

@@ -1,12 +1,18 @@
 # -*- coding: utf-8 -*-
-from openapi_schema_validator._format import oas30_format_checker
+from openapi_schema_validator._format import oas30_format_checker, oas31_format_checker
 from openapi_schema_validator.shortcuts import validate
-from openapi_schema_validator.validators import OAS30Validator
+from openapi_schema_validator.validators import OAS30Validator, OAS31Validator
 
 __author__ = 'Artur Maciag'
 __email__ = '[email protected]'
 __version__ = '0.1.5'
 __url__ = 'https://github.com/p1c2u/openapi-schema-validator'
 __license__ = 'BSD 3-Clause License'
 
-__all__ = ['validate', 'OAS30Validator', 'oas30_format_checker']
+__all__ = [
+    'validate',
+    'OAS30Validator',
+    'oas30_format_checker',
+    'OAS31Validator',
+    'oas31_format_checker',
+]

openapi_schema_validator/_format.py

@@ -145,3 +145,4 @@ def check(self, instance, format):
 
 
 oas30_format_checker = OASFormatChecker()
+oas31_format_checker = oas30_format_checker

openapi_schema_validator/_types.py

@@ -1,6 +1,6 @@
 from jsonschema._types import (
     TypeChecker, is_array, is_bool, is_integer,
-    is_object, is_number,
+    is_object, is_number, draft202012_type_checker,
 )
 from six import text_type, binary_type
 
@@ -19,3 +19,4 @@ def is_string(checker, instance):
         u"object": is_object,
     },
 )
+oas31_type_checker = draft202012_type_checker

openapi_schema_validator/shortcuts.py

@@ -1,9 +1,9 @@
 from jsonschema.exceptions import best_match
 
-from openapi_schema_validator.validators import OAS30Validator
+from openapi_schema_validator.validators import OAS31Validator
 
 
-def validate(instance, schema, cls=OAS30Validator, *args, **kwargs):
+def validate(instance, schema, cls=OAS31Validator, *args, **kwargs):
     cls.check_schema(schema)
     validator = cls(schema, *args, **kwargs)
     error = best_match(validator.iter_errors(instance))

openapi_schema_validator/validators.py

@@ -1,9 +1,9 @@
 from jsonschema import _legacy_validators, _utils, _validators
-from jsonschema.validators import create
+from jsonschema.validators import create, Draft202012Validator, extend
 
 from openapi_schema_validator import _types as oas_types
 from openapi_schema_validator import _validators as oas_validators
-
+from openapi_schema_validator._types import oas31_type_checker
 
 BaseOAS30Validator = create(
     meta_schema=_utils.load_schema("draft4"),
@@ -53,6 +53,21 @@
     id_of=lambda schema: schema.get(u"id", ""),
 )
 
+BaseOAS31Validator = extend(
+    Draft202012Validator,
+    {
+        #  adjusted to OAS
+        u"description": oas_validators.not_implemented,
+        u"format": oas_validators.format,
+        # fixed OAS fields
+        u"discriminator": oas_validators.not_implemented,
+        u"xml": oas_validators.not_implemented,
+        u"externalDocs": oas_validators.not_implemented,
+        u"example": oas_validators.not_implemented,
+    },
+    type_checker=oas31_type_checker,
+)
+
 
 class OAS30Validator(BaseOAS30Validator):
 
@@ -72,3 +87,7 @@ def iter_errors(self, instance, _schema=None):
             })
 
         return super(OAS30Validator, self).iter_errors(instance, _schema)
+
+
+class OAS31Validator(BaseOAS31Validator):
+    pass

requirements.txt

@@ -1,5 +1,5 @@
 isodate
-jsonschema
+git+https://github.com/Julian/jsonschema@main#egg=jsonschema[format]
 six
 strict-rfc3339
 rfc3339-validator

setup.cfg

@@ -9,8 +9,6 @@ classifiers =
     Intended Audience :: Developers
     Topic :: Software Development :: Libraries :: Python Modules
     Operating System :: OS Independent
-    Programming Language :: Python :: 2.7
-    Programming Language :: Python :: 3.5
     Programming Language :: Python :: 3.6
     Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
@@ -22,15 +20,14 @@ include_package_data = True
 packages = find:
 zip_safe = False
 test_suite = tests
-python_requires = >= 2.7, != 3.0.*, != 3.1.*, != 3.2.*, != 3.3.*, != 3.4.*
+python_requires = >= 3.6
 setup_requires =
     setuptools
 install_requires =
     isodate
     jsonschema>=3.0.0
     six
 tests_require =
-    mock; python_version<"3.0"
     pytest
     pytest-flake8
     pytest-cov