Merge pull request #12 from mike-oakley/u/mike/infer-schema-version

feat: Support parsing with schema version inference.

Author: mike-oakley

.vscode/settings.json

@@ -1,6 +1,7 @@
 {
     "python.testing.pytestArgs": [
-        "tests"
+        "tests",
+        "-vv"
     ],
     "python.testing.unittestEnabled": false,
     "python.testing.pytestEnabled": true,

README.md

@@ -74,9 +74,20 @@ Pydantic is a great tool, allow you to use object / dict / mixed data for for in
 The following examples give the same OpenAPI result as above:
 
 ```python
-from openapi_pydantic import OpenAPI, PathItem, Response
+from openapi_pydantic import parse_obj, OpenAPI, PathItem, Response
 
-# Construct OpenAPI from dict
+# Construct OpenAPI from dict, inferring the correct schema version
+open_api = parse_obj({
+    "info": {"title": "My own API", "version": "v0.0.1"},
+    "paths": {
+        "/ping": {
+            "get": {"responses": {"200": {"description": "pong"}}}
+        }
+    },
+})
+
+
+# Construct OpenAPI v3.1.0 schema from dict
 open_api = OpenAPI.parse_obj({
     "info": {"title": "My own API", "version": "v0.0.1"},
     "paths": {

openapi_pydantic/__init__.py

@@ -31,5 +31,6 @@
 from .v3 import Server as Server
 from .v3 import ServerVariable as ServerVariable
 from .v3 import Tag as Tag
+from .v3 import parse_obj as parse_obj
 
 logging.getLogger(__name__).addHandler(logging.NullHandler())

openapi_pydantic/v3/__init__.py

@@ -1,3 +1,4 @@
+from .parser import parse_obj as parse_obj
 from .v3_1_0 import XML as XML
 from .v3_1_0 import Callback as Callback
 from .v3_1_0 import Components as Components

openapi_pydantic/v3/parser.py

@@ -0,0 +1,15 @@
+from typing import Any, Union
+
+from pydantic import BaseModel, Field
+
+from .v3_0_3 import OpenAPI as OpenAPIv3_0
+from .v3_1_0 import OpenAPI as OpenAPIv3_1
+
+
+class _OpenAPI(BaseModel):
+    __root__: Union[OpenAPIv3_1, OpenAPIv3_0] = Field(discriminator="openapi")
+
+
+def parse_obj(data: Any) -> Union[OpenAPIv3_1, OpenAPIv3_0]:
+    """Parse a raw object into an OpenAPI model with version inference."""
+    return _OpenAPI.parse_obj(data).__root__

openapi_pydantic/v3/v3_0_3/open_api.py

@@ -1,4 +1,4 @@
-from typing import List, Optional
+from typing import List, Literal, Optional
 
 from pydantic import BaseModel, Extra
 
@@ -14,7 +14,7 @@
 class OpenAPI(BaseModel):
     """This is the root document object of the OpenAPI document."""
 
-    openapi: str = "3.0.3"
+    openapi: Literal["3.0.3", "3.0.2", "3.0.1", "3.0.0"] = "3.0.3"
     """
     **REQUIRED**. This string MUST be the [semantic version number](https://semver.org/spec/v2.0.0.html)
     of the [OpenAPI Specification version](#versions) that the OpenAPI document uses. 

openapi_pydantic/v3/v3_1_0/open_api.py

@@ -1,4 +1,4 @@
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Literal, Optional, Union
 
 from pydantic import BaseModel, Extra
 
@@ -16,7 +16,7 @@
 class OpenAPI(BaseModel):
     """This is the root document object of the OpenAPI document."""
 
-    openapi: str = "3.1.0"
+    openapi: Literal["3.1.0"] = "3.1.0"
     """
     **REQUIRED**. This string MUST be the [version number](#versions)
     of the OpenAPI Specification that the OpenAPI document uses.

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openapi-pydantic"
-version = "0.1.1"
+version = "0.2.0"
 description = "Pydantic OpenAPI schema implementation"
 authors = ["Mike Oakley <[email protected]>"]
 readme = "README.md"

tests/test_parse.py

@@ -0,0 +1,39 @@
+from typing import Literal
+
+import pytest
+
+from openapi_pydantic import parse_obj
+from openapi_pydantic.v3 import v3_0_3, v3_1_0
+
+
+@pytest.mark.parametrize("version", ["3.0.3", "3.0.2", "3.0.1", "3.0.0"])
+def test_parse_obj_3_0_3(version: Literal["3.0.3", "3.0.2", "3.0.1", "3.0.0"]) -> None:
+    result = parse_obj(
+        {
+            "openapi": version,
+            "info": {"title": "foo", "version": "0.1.0"},
+            "paths": {"/": {}},
+        }
+    )
+
+    assert result == v3_0_3.OpenAPI(
+        openapi=version,
+        info=v3_0_3.Info(title="foo", version="0.1.0"),
+        paths={"/": v3_0_3.PathItem()},
+    )
+
+
+def test_parse_obj_3_1_0() -> None:
+    result = parse_obj(
+        {
+            "openapi": "3.1.0",
+            "info": {"title": "foo", "version": "0.1.0"},
+            "paths": {"/": {}},
+        }
+    )
+
+    assert result == v3_1_0.OpenAPI(
+        openapi="3.1.0",
+        info=v3_1_0.Info(title="foo", version="0.1.0"),
+        paths={"/": v3_1_0.PathItem()},
+    )

tests/test_swagger_openapi_v3.py

@@ -2,7 +2,7 @@
 
 from pydantic import Field
 
-from openapi_pydantic import OpenAPI, Operation, PathItem
+from openapi_pydantic.v3.v3_0_3 import OpenAPI, Operation, PathItem
 
 
 def test_swagger_openapi_v3() -> None: