Merge pull request #143 from p1c2u/anexia-it-master

Implements OpenAPI 3.1 spec validator

Author: p1c2u

README.rst

@@ -19,12 +19,11 @@ About
 #####
 
 OpenAPI Spec Validator is a Python library that validates OpenAPI Specs
-against the `OpenAPI 2.0 (aka
-Swagger) <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>`__
-and `OpenAPI
-3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md>`__
-specification. The validator aims to check for full compliance with the
-Specification.
+against the `OpenAPI 2.0 (aka Swagger)
+<https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md>`__,
+`OpenAPI 3.0 <https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md>`__
+and `OpenAPI 3.1 <https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md>`__
+specification. The validator aims to check for full compliance with the Specification.
 
 Installation
 ############
@@ -73,7 +72,7 @@ or more pythonic way:
 Examples
 ********
 
-By default, OpenAPI v3 syntax is expected. To validate an OpenAPI v3 spec:
+By default, OpenAPI v3.1 syntax is expected. To validate an OpenAPI v3.1 spec:
 
 .. code:: python
 
@@ -91,7 +90,11 @@ By default, OpenAPI v3 syntax is expected. To validate an OpenAPI v3 spec:
         ...
     OpenAPIValidationError: 'openapi' is a required property
     
-In order to validate a Swagger / OpenAPI 2.0 spec file, import ``validate_v2_spec`` instead of ``validate_spec``. You can also explicitly import ``validate_v3_spec`` if you want to disambiguate the expected version.
+In order to validate a Swagger / OpenAPI 2.0 spec file, import ``validate_v2_spec`` instead of ``validate_spec``.
+In order to validate a OpenAPI 3.0 spec file, import ``validate_v30_spec`` instead of ``validate_spec``.
+
+You can also explicitly import ``validate_v31_spec`` if you want to disambiguate the expected version or
+explicitly import ``validate_v3_spec`` which is a shortcut to the latest v3 release.
 
 Add ``spec_url`` to validate spec with relative files:
 

openapi_spec_validator/__init__.py

@@ -4,7 +4,8 @@
 )
 from openapi_spec_validator.handlers import UrlHandler, FileObjectHandler
 from openapi_spec_validator.schemas import get_openapi_schema
-from openapi_spec_validator.factories import JSONSpecValidatorFactory
+from openapi_spec_validator.factories import \
+    Draft202012JSONSpecValidatorFactory, Draft4JSONSpecValidatorFactory
 from openapi_spec_validator.validators import SpecValidator
 
 __author__ = 'Artur Maciag'
@@ -14,9 +15,20 @@
 __license__ = 'Apache License, Version 2.0'
 
 __all__ = [
-    'openapi_v2_spec_validator', 'openapi_v3_spec_validator',
-    'validate_v2_spec', 'validate_v3_spec', 'validate_spec',
-    'validate_v2_spec_url', 'validate_v3_spec_url', 'validate_spec_url',
+    'openapi_v2_spec_validator',
+    'openapi_v3_spec_validator',
+    'openapi_v30_spec_validator',
+    'openapi_v31_spec_validator',
+    'validate_v2_spec',
+    'validate_v3_spec',
+    'validate_v30_spec',
+    'validate_v31_spec',
+    'validate_spec',
+    'validate_v2_spec_url',
+    'validate_v3_spec_url',
+    'validate_v30_spec_url',
+    'validate_v31_spec_url',
+    'validate_spec_url',
 ]
 
 file_object_handler = FileObjectHandler()
@@ -30,7 +42,7 @@
 
 # v2.0 spec
 schema_v2, schema_v2_url = get_openapi_schema('2.0')
-openapi_v2_validator_factory = JSONSpecValidatorFactory(
+openapi_v2_validator_factory = Draft4JSONSpecValidatorFactory(
     schema_v2, schema_v2_url,
     resolver_handlers=default_handlers,
 )
@@ -40,13 +52,24 @@
 )
 
 # v3.0 spec
-schema_v3, schema_v3_url = get_openapi_schema('3.0')
-openapi_v3_validator_factory = JSONSpecValidatorFactory(
-    schema_v3, schema_v3_url,
+schema_v30, schema_v30_url = get_openapi_schema('3.0')
+openapi_v30_validator_factory = Draft4JSONSpecValidatorFactory(
+    schema_v30, schema_v30_url,
     resolver_handlers=default_handlers,
 )
-openapi_v3_spec_validator = SpecValidator(
-    openapi_v3_validator_factory,
+openapi_v30_spec_validator = SpecValidator(
+    openapi_v30_validator_factory,
+    resolver_handlers=default_handlers,
+)
+
+# v3.1 spec
+schema_v31, schema_v31_url = get_openapi_schema('3.1')
+openapi_v31_validator_factory = Draft202012JSONSpecValidatorFactory(
+    schema_v31, schema_v31_url,
+    resolver_handlers=default_handlers,
+)
+openapi_v31_spec_validator = SpecValidator(
+    openapi_v31_validator_factory,
     resolver_handlers=default_handlers,
 )
 
@@ -55,9 +78,22 @@
 validate_v2_spec_url = validate_spec_url_factory(
     openapi_v2_spec_validator.validate, default_handlers)
 
-validate_v3_spec = validate_spec_factory(openapi_v3_spec_validator.validate)
-validate_v3_spec_url = validate_spec_url_factory(
-    openapi_v3_spec_validator.validate, default_handlers)
+validate_v30_spec = validate_spec_factory(openapi_v30_spec_validator.validate)
+validate_v30_spec_url = validate_spec_url_factory(
+    openapi_v30_spec_validator.validate, default_handlers)
+
+
+validate_v31_spec = validate_spec_factory(openapi_v31_spec_validator.validate)
+validate_v31_spec_url = validate_spec_url_factory(
+    openapi_v31_spec_validator.validate, default_handlers)
+
+# aliases to the latest v3 version
+schema_v3 = schema_v31
+schema_v3_url = schema_v31_url
+openapi_v3_validator_factory = openapi_v31_validator_factory
+openapi_v3_spec_validator = openapi_v31_spec_validator
+validate_v3_spec = validate_v31_spec
+validate_v3_spec_url = validate_v31_spec_url
 
 # aliases to the latest version
 validate_spec = validate_v3_spec

openapi_spec_validator/__main__.py

@@ -5,7 +5,9 @@
 from jsonschema.exceptions import best_match
 
 from openapi_spec_validator import (
-    openapi_v2_spec_validator, openapi_v3_spec_validator,
+    openapi_v2_spec_validator,
+    openapi_v30_spec_validator,
+    openapi_v31_spec_validator,
 )
 from openapi_spec_validator.exceptions import ValidationError
 from openapi_spec_validator.readers import read_from_stdin, read_from_filename
@@ -50,10 +52,10 @@ def main(args=None):
     )
     parser.add_argument(
         '--schema',
-        help="OpenAPI schema (default: 3.0.0)",
+        help="OpenAPI schema (default: 3.1.0)",
         type=str,
-        choices=['2.0', '3.0.0'],
-        default='3.0.0'
+        choices=['2.0', '3.0.0', '3.1.0'],
+        default='3.1.0'
     )
     args = parser.parse_args(args)
 
@@ -72,7 +74,8 @@ def main(args=None):
     # choose the validator
     validators = {
         '2.0': openapi_v2_spec_validator,
-        '3.0.0': openapi_v3_spec_validator,
+        '3.0.0': openapi_v30_spec_validator,
+        '3.1.0': openapi_v31_spec_validator,
     }
     validator = validators[args.schema]
 

openapi_spec_validator/factories.py

@@ -1,6 +1,7 @@
 """OpenAPI spec validator factories module."""
 from jsonschema import validators
-from jsonschema.validators import Draft4Validator, RefResolver
+from jsonschema.validators import Draft4Validator, RefResolver, \
+    Draft202012Validator
 
 from openapi_spec_validator.generators import (
     SpecValidatorsGeneratorFactory,
@@ -28,16 +29,15 @@ def _get_spec_validators(cls, spec_resolver):
         return dict(list(generator))
 
 
-class JSONSpecValidatorFactory:
+class BaseJSONSpecValidatorFactory:
     """
     Json documents validator factory against a json schema.
 
     :param schema: schema for validation.
     :param schema_url: schema base uri.
     """
 
-    schema_validator_class = Draft4Validator
-    spec_validator_factory = Draft4ExtendedValidatorFactory
+    schema_validator_class = None
 
     def __init__(self, schema, schema_url='', resolver_handlers=None):
         self.schema = schema
@@ -46,6 +46,17 @@ def __init__(self, schema, schema_url='', resolver_handlers=None):
 
         self.schema_validator_class.check_schema(self.schema)
 
+
+class Draft4JSONSpecValidatorFactory(BaseJSONSpecValidatorFactory):
+    """
+    Json documents validator factory that uses Draft4Validator
+
+    :param schema: schema for validation.
+    :param schema_url: schema base uri.
+    """
+    schema_validator_class = Draft4Validator
+    spec_validator_factory = Draft4ExtendedValidatorFactory
+
     @property
     def schema_resolver(self):
         return self._get_resolver(self.schema_url, self.schema)
@@ -67,3 +78,17 @@ def create(self, spec_resolver):
     def _get_resolver(self, base_uri, referrer):
         return RefResolver(
             base_uri, referrer, handlers=self.resolver_handlers)
+
+
+class Draft202012JSONSpecValidatorFactory(BaseJSONSpecValidatorFactory):
+    """
+    Json documents validator factory that uses Draft202012Validator
+
+    :param schema: schema for validation.
+    :param schema_url: schema base uri.
+    """
+
+    schema_validator_class = Draft202012Validator
+
+    def create(self, spec_resolver):
+        return self.schema_validator_class(self.schema)