#296: Adds support for OpenAPI 3.1

Author: nezhar

.github/workflows/python-test.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-    
+
       - name: Get full Python version
         id: full-python-version
         run: echo ::set-output name=version::$(python -c "import sys; print('-'.join(str(v) for v in sys.version_info))")

.gitignore

@@ -46,6 +46,7 @@ nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
+tests/**/reports
 
 # Translations
 *.mo
@@ -104,4 +105,4 @@ ENV/
 # Jetbrains project files
 .idea/
 
-/reports/
+/reports/

openapi_core/spec/shortcuts.py

@@ -11,10 +11,11 @@ def create_spec(
     spec_dict,
     spec_url="",
     handlers=default_handlers,
+    spec_validator=openapi_v3_spec_validator,
     validate_spec=True,
 ):
     if validate_spec:
-        openapi_v3_spec_validator.validate(spec_dict, spec_url=spec_url)
+        spec_validator.validate(spec_dict, spec_url=spec_url)
 
     spec_resolver = RefResolver(spec_url, spec_dict, handlers=handlers)
     dereferencer = Dereferencer(spec_resolver)

poetry.lock

@@ -41,8 +41,8 @@ flask = {version = "*", optional = true}
 isodate = "*"
 more-itertools = "*"
 parse = "*"
-openapi-schema-validator = "^0.2.0"
-openapi-spec-validator = "^0.4.0"
+openapi-schema-validator = {version = "0.3.0a1", allow-prereleases = true}
+openapi-spec-validator = {version = "0.5.0a1", allow-prereleases = true}
 requests = {version = "*", optional = true}
 werkzeug = "*"
 

pyproject.toml

@@ -14,6 +14,7 @@
 from pathlib import Path
 
 import yaml
+from openapi_spec_validator import openapi_v30_spec_validator
 
 from openapi_core import create_spec
 
@@ -123,4 +124,6 @@
 
 OPENAPI_SPEC_DICT = yaml.load(OPENAPI_SPEC_PATH.read_text(), yaml.Loader)
 
-OPENAPI_SPEC = create_spec(OPENAPI_SPEC_DICT)
+OPENAPI_SPEC = create_spec(
+    OPENAPI_SPEC_DICT, spec_validator=openapi_v30_spec_validator
+)

tests/integration/contrib/django/data/v3.0/djangoproject/settings.py

@@ -1,11 +1,12 @@
 from pathlib import Path
 
 import yaml
+from openapi_spec_validator import openapi_v30_spec_validator
 
 from openapi_core import create_spec
 from openapi_core.contrib.falcon.middlewares import FalconOpenAPIMiddleware
 
 openapi_spec_path = Path("tests/integration/data/v3.0/petstore.yaml")
 spec_dict = yaml.load(openapi_spec_path.read_text(), yaml.Loader)
-spec = create_spec(spec_dict)
+spec = create_spec(spec_dict, spec_validator=openapi_v30_spec_validator)
 openapi_middleware = FalconOpenAPIMiddleware.from_spec(spec)

tests/integration/contrib/falcon/data/v3.0/falconproject/openapi.py

@@ -2,6 +2,7 @@
 from flask import Flask
 from flask import jsonify
 from flask import make_response
+from openapi_spec_validator import openapi_v30_spec_validator
 
 from openapi_core.contrib.flask.decorators import FlaskOpenAPIViewDecorator
 from openapi_core.shortcuts import create_spec
@@ -15,7 +16,10 @@ class TestFlaskOpenAPIDecorator:
     @pytest.fixture
     def spec(self, factory):
         specfile = "contrib/flask/data/v3.0/flask_factory.yaml"
-        return create_spec(factory.spec_from_file(specfile))
+        return create_spec(
+            factory.spec_from_file(specfile),
+            spec_validator=openapi_v30_spec_validator,
+        )
 
     @pytest.fixture
     def decorator(self, spec):

tests/integration/contrib/flask/test_flask_decorator.py

@@ -1,4 +1,5 @@
 import pytest
+from openapi_spec_validator import openapi_v30_spec_validator
 
 from openapi_core.contrib.flask import FlaskOpenAPIRequest
 from openapi_core.contrib.flask import FlaskOpenAPIResponse
@@ -11,7 +12,10 @@ class TestFlaskOpenAPIValidation:
     @pytest.fixture
     def flask_spec(self, factory):
         specfile = "contrib/flask/data/v3.0/flask_factory.yaml"
-        return create_spec(factory.spec_from_file(specfile))
+        return create_spec(
+            factory.spec_from_file(specfile),
+            spec_validator=openapi_v30_spec_validator,
+        )
 
     def test_response_validator_path_pattern(
         self, flask_spec, request_factory, response_factory

tests/integration/contrib/flask/test_flask_validation.py

@@ -2,6 +2,7 @@
 from flask import Flask
 from flask import jsonify
 from flask import make_response
+from openapi_spec_validator import openapi_v30_spec_validator
 
 from openapi_core.contrib.flask.views import FlaskOpenAPIView
 from openapi_core.shortcuts import create_spec
@@ -14,7 +15,10 @@ class TestFlaskOpenAPIView:
     @pytest.fixture
     def spec(self, factory):
         specfile = "contrib/flask/data/v3.0/flask_factory.yaml"
-        return create_spec(factory.spec_from_file(specfile))
+        return create_spec(
+            factory.spec_from_file(specfile),
+            spec_validator=openapi_v30_spec_validator,
+        )
 
     @pytest.fixture
     def app(self):

tests/integration/contrib/flask/test_flask_views.py

@@ -1,6 +1,7 @@
 import pytest
 import requests
 import responses
+from openapi_spec_validator import openapi_v30_spec_validator
 
 from openapi_core.contrib.requests import RequestsOpenAPIRequest
 from openapi_core.contrib.requests import RequestsOpenAPIResponse
@@ -13,7 +14,10 @@ class TestRequestsOpenAPIValidation:
     @pytest.fixture
     def spec(self, factory):
         specfile = "contrib/requests/data/v3.0/requests_factory.yaml"
-        return create_spec(factory.spec_from_file(specfile))
+        return create_spec(
+            factory.spec_from_file(specfile),
+            spec_validator=openapi_v30_spec_validator,
+        )
 
     @responses.activate
     def test_response_validator_path_pattern(self, spec):

tests/integration/contrib/requests/test_requests_validation.py

@@ -0,0 +1,19 @@
+openapi: "3.1.0"
+info:
+  title: Basic OpenAPI specification used with test_flask.TestFlaskOpenAPIIValidation
+  version: "0.1"
+servers:
+  - url: 'http://testserver'
+paths:
+  '/admin/auth/group/{object_id}/':
+    parameters:
+      - name: object_id
+        in: path
+        required: true
+        description: the ID of the resource to retrieve
+        schema:
+          type: integer
+    get:
+      responses:
+        default:
+          description: Return the resource.

tests/integration/data/v3.1/django_factory.yaml

@@ -0,0 +1 @@
+openapi: "3.1.0"

tests/integration/data/v3.1/empty.yaml

@@ -0,0 +1,48 @@
+openapi: "3.1.0"
+info:
+  title: Minimal valid OpenAPI specification
+  version: "0.1"
+paths:
+  /linked/noParam:
+    get:
+      operationId: noParOp
+      responses:
+        default:
+          description: the linked result
+  /linked/withParam:
+    get:
+      operationId: paramOp
+      parameters:
+        - name: opParam
+          in: query
+          description: test
+          schema:
+            type: string
+      responses:
+        default:
+          description: the linked result
+  /status:
+    get:
+      responses:
+        default:
+          description: Return something
+          links:
+            noParamLink:
+              operationId: noParOp
+  /status/{resourceId}:
+    get:
+      parameters:
+        - name: resourceId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        default:
+          description: Return something else
+          links:
+            paramLink:
+              operationId: paramOp
+              parameters:
+                opParam: $request.path.resourceId
+              requestBody: test

tests/integration/data/v3.1/links.yaml

@@ -0,0 +1,10 @@
+openapi: "3.1.0"
+info:
+  title: Minimal valid OpenAPI specification
+  version: "0.1"
+paths:
+  /status:
+    get:
+      responses:
+        default:
+          description: Return the API status.

tests/integration/data/v3.1/minimal.yaml

@@ -0,0 +1,12 @@
+openapi: "3.1.0"
+info:
+  title: Minimal valid OpenAPI specification with explicit 'servers' array
+  version: "0.1"
+servers:
+  - url: /
+paths:
+  /status:
+    get:
+      responses:
+        default:
+          description: Return the API status.

tests/integration/data/v3.1/minimal_with_servers.yaml

@@ -0,0 +1,17 @@
+openapi: "3.1.0"
+info:
+  title: Minimal OpenAPI specification with path parameters
+  version: "0.1"
+paths:
+  /resource/{resId}:
+    parameters:
+      - name: resId
+        in: path
+        required: true
+        description: the ID of the resource to retrieve
+        schema:
+          type: string
+    get:
+      responses:
+        default:
+          description: Return the resource.