fix: OpenAPI schema validation issues (#426, #568). Thanks @p1-ra!

BREAKING CHANGE: Validation of OpenAPI documents is now more strict.
Co-authored-by: Nementon <nementon@badwolf.fr>
Co-authored-by: p1-ra <aurelien.roose@p1sec.com>

Author: 3 people

openapi_python_client/parser/properties/__init__.py

@@ -453,6 +453,7 @@ def build_union_property(
             constructed `UnionProperty` or a `PropertyError` describing what went wrong.
     """
     sub_properties: List[Property] = []
+
     for i, sub_prop_data in enumerate(chain(data.anyOf, data.oneOf)):
         sub_prop, schemas = property_from_data(
             name=f"{name}_type_{i}",
@@ -570,8 +571,8 @@ def _property_from_data(
     if isinstance(data, oai.Reference):
         return _property_from_ref(name=name, required=required, parent=None, data=data, schemas=schemas, config=config)
 
+    sub_data: List[Union[oai.Schema, oai.Reference]] = data.allOf + data.anyOf + data.oneOf
     # A union of a single reference should just be passed through to that reference (don't create copy class)
-    sub_data = (data.allOf or []) + data.anyOf + data.oneOf
     if len(sub_data) == 1 and isinstance(sub_data[0], oai.Reference):
         return _property_from_ref(
             name=name, required=required, parent=data, data=sub_data[0], schemas=schemas, config=config

openapi_python_client/parser/properties/model_property.py

@@ -135,7 +135,7 @@ def _add_if_no_conflict(new_prop: Property) -> Optional[PropertyError]:
         return None
 
     unprocessed_props = data.properties or {}
-    for sub_prop in data.allOf or []:
+    for sub_prop in data.allOf:
         if isinstance(sub_prop, oai.Reference):
             ref_path = parse_reference_path(sub_prop.ref)
             if isinstance(ref_path, ParseError):

openapi_python_client/schema/openapi_schema_pydantic/README.md

@@ -1,5 +1,8 @@
 Everything in this directory (including the rest of this file after this paragraph) is a vendored copy of [openapi-schem-pydantic](https://github.com/kuimono/openapi-schema-pydantic) and is licensed under the LICENSE file in this directory.
 
+Included vendored version is the [following](https://github.com/kuimono/openapi-schema-pydantic/commit/0836b429086917feeb973de3367a7ac4c2b3a665)
+Small patches has been applied to it.
+
 ## Alias
 
 Due to the reserved words in python and pydantic,

openapi_python_client/schema/openapi_schema_pydantic/__init__.py

@@ -36,8 +36,11 @@
     "ServerVariable",
     "Tag",
     "XML",
+    "Callback",
 ]
 
+
+from .callback import Callback
 from .components import Components
 from .contact import Contact
 from .discriminator import Discriminator

openapi_python_client/schema/openapi_schema_pydantic/callback.py

@@ -0,0 +1,15 @@
+from typing import TYPE_CHECKING, Dict
+
+if TYPE_CHECKING:  # pragma: no cover
+    from .path_item import PathItem
+else:
+    PathItem = "PathItem"  # pylint: disable=invalid-name
+
+Callback = Dict[str, PathItem]
+"""
+A map of possible out-of band callbacks related to the parent operation.
+Each value in the map is a [Path Item Object](#pathItemObject)
+that describes a set of requests that may be initiated by the API provider and the expected responses.
+The key value used to identify the path item object is an expression, evaluated at runtime,
+that identifies a URL to use for the callback operation.
+"""

openapi_python_client/schema/openapi_schema_pydantic/components.py

@@ -1,7 +1,8 @@
 from typing import Dict, Optional, Union
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Extra
 
+from .callback import Callback
 from .example import Example
 from .header import Header
 from .link import Link
@@ -32,8 +33,10 @@ class Components(BaseModel):
     headers: Optional[Dict[str, Union[Header, Reference]]] = None
     securitySchemes: Optional[Dict[str, Union[SecurityScheme, Reference]]] = None
     links: Optional[Dict[str, Union[Link, Reference]]] = None
+    callbacks: Optional[Dict[str, Union[Callback, Reference]]] = None
 
     class Config:  # pylint: disable=missing-class-docstring
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {

openapi_python_client/schema/openapi_schema_pydantic/contact.py

@@ -1,6 +1,6 @@
 from typing import Optional
 
-from pydantic import AnyUrl, BaseModel
+from pydantic import AnyUrl, BaseModel, Extra
 
 
 class Contact(BaseModel):
@@ -16,6 +16,7 @@ class Contact(BaseModel):
     email: Optional[str] = None
 
     class Config:  # pylint: disable=missing-class-docstring
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"name": "API Support", "url": "http://www.example.com/support", "email": "support@example.com"}

openapi_python_client/schema/openapi_schema_pydantic/discriminator.py

@@ -1,6 +1,6 @@
 from typing import Dict, Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Extra
 
 
 class Discriminator(BaseModel):
@@ -22,6 +22,7 @@ class Discriminator(BaseModel):
     mapping: Optional[Dict[str, str]] = None
 
     class Config:  # pylint: disable=missing-class-docstring
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {

openapi_python_client/schema/openapi_schema_pydantic/encoding.py

@@ -1,9 +1,14 @@
-from typing import Dict, Optional
+from typing import TYPE_CHECKING, Dict, Optional, Union
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Extra
 
 from .reference import Reference
 
+if TYPE_CHECKING:  # pragma: no cover
+    from .header import Header
+else:
+    Header = "Header"  # pylint: disable=invalid-name
+
 
 class Encoding(BaseModel):
     """A single encoding definition applied to a single schema property.
@@ -14,12 +19,13 @@ class Encoding(BaseModel):
     """
 
     contentType: Optional[str] = None
-    headers: Optional[Dict[str, Reference]] = None
+    headers: Optional[Dict[str, Union[Header, Reference]]] = None
     style: Optional[str] = None
     explode: bool = False
     allowReserved: bool = False
 
     class Config:  # pylint: disable=missing-class-docstring
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {

openapi_python_client/schema/openapi_schema_pydantic/example.py

@@ -1,6 +1,6 @@
 from typing import Any, Optional
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Extra
 
 
 class Example(BaseModel):
@@ -17,6 +17,7 @@ class Example(BaseModel):
     externalValue: Optional[str] = None
 
     class Config:  # pylint: disable=missing-class-docstring
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"summary": "A foo example", "value": {"foo": "bar"}},