openapi_schema_pydantic / allow extra values

p1-ra · p1-ra · commit b552181d44d7 · 2021-05-13T19:54:03.000+02:00
- For support of OAI vendor extension
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/components.py b/openapi_python_client/schema/openapi_schema_pydantic/components.py
@@ -49,7 +49,7 @@ class Components(BaseModel):
     """An object to hold reusable [Callback Objects](#callbackObject)."""
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/contact.py b/openapi_python_client/schema/openapi_schema_pydantic/contact.py
@@ -26,7 +26,7 @@ class Contact(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"name": "API Support", "url": "http://www.example.com/support", "email": "support@example.com"}
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/discriminator.py b/openapi_python_client/schema/openapi_schema_pydantic/discriminator.py
@@ -25,7 +25,7 @@ class Discriminator(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/encoding.py b/openapi_python_client/schema/openapi_schema_pydantic/encoding.py
@@ -60,7 +60,7 @@ class Encoding(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/example.py b/openapi_python_client/schema/openapi_schema_pydantic/example.py
@@ -33,7 +33,7 @@ class Example(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"summary": "A foo example", "value": {"foo": "bar"}},
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/external_documentation.py b/openapi_python_client/schema/openapi_schema_pydantic/external_documentation.py
@@ -19,5 +19,5 @@ class ExternalDocumentation(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {"examples": [{"description": "Find more info here", "url": "https://example.com"}]}
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/header.py b/openapi_python_client/schema/openapi_schema_pydantic/header.py
@@ -18,7 +18,7 @@ class Header(Parameter):
     param_in = Field(default=ParameterLocation.HEADER, const=True, alias="in")
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/info.py b/openapi_python_client/schema/openapi_schema_pydantic/info.py
@@ -47,7 +47,7 @@ class Info(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/license.py b/openapi_python_client/schema/openapi_schema_pydantic/license.py
@@ -20,5 +20,5 @@ class License(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {"examples": [{"name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html"}]}
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/link.py b/openapi_python_client/schema/openapi_schema_pydantic/link.py
@@ -63,7 +63,7 @@ class Link(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"operationId": "getUserAddressByUUID", "parameters": {"userUuid": "$response.body#/uuid"}},
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/media_type.py b/openapi_python_client/schema/openapi_schema_pydantic/media_type.py
@@ -49,7 +49,7 @@ class MediaType(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/oauth_flow.py b/openapi_python_client/schema/openapi_schema_pydantic/oauth_flow.py
@@ -35,7 +35,7 @@ class OAuthFlow(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/oauth_flows.py b/openapi_python_client/schema/openapi_schema_pydantic/oauth_flows.py
@@ -35,4 +35,4 @@ class OAuthFlows(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/open_api.py b/openapi_python_client/schema/openapi_schema_pydantic/open_api.py
@@ -60,4 +60,4 @@ class OpenAPI(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/operation.py b/openapi_python_client/schema/openapi_schema_pydantic/operation.py
@@ -104,7 +104,7 @@ class Operation(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/parameter.py b/openapi_python_client/schema/openapi_schema_pydantic/parameter.py
@@ -142,7 +142,7 @@ class Parameter(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/path_item.py b/openapi_python_client/schema/openapi_schema_pydantic/path_item.py
@@ -92,7 +92,7 @@ class PathItem(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/reference.py b/openapi_python_client/schema/openapi_schema_pydantic/reference.py
@@ -16,7 +16,7 @@ class Reference(BaseModel):
     """**REQUIRED**. The reference string."""
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [{"$ref": "#/components/schemas/Pet"}, {"$ref": "Pet.json"}, {"$ref": "definitions.json#/Pet"}]
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/request_body.py b/openapi_python_client/schema/openapi_schema_pydantic/request_body.py
@@ -31,7 +31,7 @@ class RequestBody(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/response.py b/openapi_python_client/schema/openapi_schema_pydantic/response.py
@@ -44,7 +44,7 @@ class Response(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/schema.py b/openapi_python_client/schema/openapi_schema_pydantic/schema.py
@@ -472,7 +472,7 @@ class Schema(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/security_scheme.py b/openapi_python_client/schema/openapi_schema_pydantic/security_scheme.py
@@ -66,7 +66,7 @@ class SecurityScheme(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/server.py b/openapi_python_client/schema/openapi_schema_pydantic/server.py
@@ -31,7 +31,7 @@ class Server(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"url": "https://development.gigantic-server.com/v1", "description": "Development server"},
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/server_variable.py b/openapi_python_client/schema/openapi_schema_pydantic/server_variable.py
@@ -28,4 +28,4 @@ class ServerVariable(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/tag.py b/openapi_python_client/schema/openapi_schema_pydantic/tag.py
@@ -28,5 +28,5 @@ class Tag(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {"examples": [{"name": "pet", "description": "Pets operations"}]}
diff --git a/openapi_python_client/schema/openapi_schema_pydantic/xml.py b/openapi_python_client/schema/openapi_schema_pydantic/xml.py
@@ -48,7 +48,7 @@ class XML(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.allow
         schema_extra = {
             "examples": [
                 {"namespace": "http://example.com/schema/sample", "prefix": "sample"},
diff --git a/tests/test_parser/test_openapi.py b/tests/test_parser/test_openapi.py
@@ -92,15 +92,13 @@ def test_swagger_document_invalid_schema(self, mocker):
             header="Failed to parse OpenAPI document",
             detail=(
                 "You may be trying to use a Swagger document; this is not supported by this project.\n\n"
-                "4 validation errors for OpenAPI\n"
+                "3 validation errors for OpenAPI\n"
                 "info\n"
                 "  field required (type=value_error.missing)\n"
                 "paths\n"
                 "  field required (type=value_error.missing)\n"
                 "openapi\n"
-                "  field required (type=value_error.missing)\n"
-                "swagger\n"
-                "  extra fields not permitted (type=value_error.extra)"
+                "  field required (type=value_error.missing)"
             ),
         )
         Schemas.build.assert_not_called()

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,7 @@ class Components(BaseModel):`
`49`	`49`	`"""An object to hold reusable [Callback Objects](#callbackObject)."""`
`50`	`50`
`51`	`51`	`class Config:`
`52`		`- extra = Extra.forbid`
	`52`	`+ extra = Extra.allow`
`53`	`53`	`schema_extra = {`
`54`	`54`	`"examples": [`
`55`	`55`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ class Discriminator(BaseModel):`
`25`	`25`	`"""`
`26`	`26`
`27`	`27`	`class Config:`
`28`		`- extra = Extra.forbid`
	`28`	`+ extra = Extra.allow`
`29`	`29`	`schema_extra = {`
`30`	`30`	`"examples": [`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ class Encoding(BaseModel):`
`60`	`60`	`"""`
`61`	`61`
`62`	`62`	`class Config:`
`63`		`- extra = Extra.forbid`
	`63`	`+ extra = Extra.allow`
`64`	`64`	`schema_extra = {`
`65`	`65`	`"examples": [`
`66`	`66`	`{`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ class Info(BaseModel):`
`47`	`47`	`"""`
`48`	`48`
`49`	`49`	`class Config:`
`50`		`- extra = Extra.forbid`
	`50`	`+ extra = Extra.allow`
`51`	`51`	`schema_extra = {`
`52`	`52`	`"examples": [`
`53`	`53`	`{`