Merge pull request #11 from kuimono/9-ignore-extra-fields-instead-of-forbid

kuimono · web-flow · commit a647d2bd87c3 · 2022-02-03T20:32:34.000+08:00
Switch to use `extra = Extra.ignore` instead of `Extra.forbid`
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,11 @@
 # Change Log
 
-## v1.2.2 - Unreleased
+## v1.2.2 - 2022-02-03
 
 ### Fixed
 - [4](https://github.com/kuimono/openapi-schema-pydantic/issues/4) Allow `Schema` type `additionalProperties` field to be boolean
+- [5](https://github.com/kuimono/openapi-schema-pydantic/issues/5) Allow URL fields in `SecurityScheme` / `OAuthFlow` to be string
+- [9](https://github.com/kuimono/openapi-schema-pydantic/issues/9) Switch to use `extra = Extra.ignore` instead of `Extra.forbid`
 
 
 ## v1.2.1 - 2021-09-10
diff --git a/openapi_schema_pydantic/v3/v3_0_3/components.py b/openapi_schema_pydantic/v3/v3_0_3/components.py
@@ -49,7 +49,7 @@ class Components(BaseModel):
     """An object to hold reusable [Callback Objects](#callbackObject)."""
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/contact.py b/openapi_schema_pydantic/v3/v3_0_3/contact.py
@@ -26,7 +26,7 @@ class Contact(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"name": "API Support", "url": "http://www.example.com/support", "email": "support@example.com"}
diff --git a/openapi_schema_pydantic/v3/v3_0_3/discriminator.py b/openapi_schema_pydantic/v3/v3_0_3/discriminator.py
@@ -25,7 +25,7 @@ class Discriminator(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/encoding.py b/openapi_schema_pydantic/v3/v3_0_3/encoding.py
@@ -60,7 +60,7 @@ class Encoding(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/example.py b/openapi_schema_pydantic/v3/v3_0_3/example.py
@@ -33,7 +33,7 @@ class Example(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"summary": "A foo example", "value": {"foo": "bar"}},
diff --git a/openapi_schema_pydantic/v3/v3_0_3/external_documentation.py b/openapi_schema_pydantic/v3/v3_0_3/external_documentation.py
@@ -19,5 +19,5 @@ class ExternalDocumentation(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {"examples": [{"description": "Find more info here", "url": "https://example.com"}]}
diff --git a/openapi_schema_pydantic/v3/v3_0_3/header.py b/openapi_schema_pydantic/v3/v3_0_3/header.py
@@ -17,7 +17,7 @@ class Header(Parameter):
     param_in = Field(default="header", const=True, alias="in")
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_0_3/info.py b/openapi_schema_pydantic/v3/v3_0_3/info.py
@@ -47,7 +47,7 @@ class Info(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/license.py b/openapi_schema_pydantic/v3/v3_0_3/license.py
@@ -20,5 +20,5 @@ class License(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {"examples": [{"name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html"}]}
diff --git a/openapi_schema_pydantic/v3/v3_0_3/link.py b/openapi_schema_pydantic/v3/v3_0_3/link.py
@@ -63,7 +63,7 @@ class Link(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"operationId": "getUserAddressByUUID", "parameters": {"userUuid": "$response.body#/uuid"}},
diff --git a/openapi_schema_pydantic/v3/v3_0_3/media_type.py b/openapi_schema_pydantic/v3/v3_0_3/media_type.py
@@ -49,7 +49,7 @@ class MediaType(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_0_3/oauth_flow.py b/openapi_schema_pydantic/v3/v3_0_3/oauth_flow.py
@@ -35,7 +35,7 @@ class OAuthFlow(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/oauth_flows.py b/openapi_schema_pydantic/v3/v3_0_3/oauth_flows.py
@@ -35,4 +35,4 @@ class OAuthFlows(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
diff --git a/openapi_schema_pydantic/v3/v3_0_3/open_api.py b/openapi_schema_pydantic/v3/v3_0_3/open_api.py
@@ -68,4 +68,4 @@ class OpenAPI(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
diff --git a/openapi_schema_pydantic/v3/v3_0_3/operation.py b/openapi_schema_pydantic/v3/v3_0_3/operation.py
@@ -104,7 +104,7 @@ class Operation(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/parameter.py b/openapi_schema_pydantic/v3/v3_0_3/parameter.py
@@ -141,7 +141,7 @@ class Parameter(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_0_3/path_item.py b/openapi_schema_pydantic/v3/v3_0_3/path_item.py
@@ -92,7 +92,7 @@ class PathItem(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_0_3/reference.py b/openapi_schema_pydantic/v3/v3_0_3/reference.py
@@ -16,7 +16,7 @@ class Reference(BaseModel):
     """**REQUIRED**. The reference string."""
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [{"$ref": "#/components/schemas/Pet"}, {"$ref": "Pet.json"}, {"$ref": "definitions.json#/Pet"}]
diff --git a/openapi_schema_pydantic/v3/v3_0_3/request_body.py b/openapi_schema_pydantic/v3/v3_0_3/request_body.py
@@ -31,7 +31,7 @@ class RequestBody(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/response.py b/openapi_schema_pydantic/v3/v3_0_3/response.py
@@ -44,7 +44,7 @@ class Response(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_0_3/schema.py b/openapi_schema_pydantic/v3/v3_0_3/schema.py
@@ -471,7 +471,7 @@ class Schema(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_0_3/security_scheme.py b/openapi_schema_pydantic/v3/v3_0_3/security_scheme.py
@@ -66,7 +66,7 @@ class SecurityScheme(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_0_3/server.py b/openapi_schema_pydantic/v3/v3_0_3/server.py
@@ -31,7 +31,7 @@ class Server(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"url": "https://development.gigantic-server.com/v1", "description": "Development server"},
diff --git a/openapi_schema_pydantic/v3/v3_0_3/server_variable.py b/openapi_schema_pydantic/v3/v3_0_3/server_variable.py
@@ -28,4 +28,4 @@ class ServerVariable(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
diff --git a/openapi_schema_pydantic/v3/v3_0_3/tag.py b/openapi_schema_pydantic/v3/v3_0_3/tag.py
@@ -28,5 +28,5 @@ class Tag(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {"examples": [{"name": "pet", "description": "Pets operations"}]}
diff --git a/openapi_schema_pydantic/v3/v3_0_3/xml.py b/openapi_schema_pydantic/v3/v3_0_3/xml.py
@@ -48,7 +48,7 @@ class XML(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"namespace": "http://example.com/schema/sample", "prefix": "sample"},
diff --git a/openapi_schema_pydantic/v3/v3_1_0/components.py b/openapi_schema_pydantic/v3/v3_1_0/components.py
@@ -53,7 +53,7 @@ class Components(BaseModel):
     """An object to hold reusable [Path Item Object](#pathItemObject)."""
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/contact.py b/openapi_schema_pydantic/v3/v3_1_0/contact.py
@@ -26,7 +26,7 @@ class Contact(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"name": "API Support", "url": "http://www.example.com/support", "email": "support@example.com"}
diff --git a/openapi_schema_pydantic/v3/v3_1_0/discriminator.py b/openapi_schema_pydantic/v3/v3_1_0/discriminator.py
@@ -25,7 +25,7 @@ class Discriminator(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/encoding.py b/openapi_schema_pydantic/v3/v3_1_0/encoding.py
@@ -68,7 +68,7 @@ class Encoding(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/example.py b/openapi_schema_pydantic/v3/v3_1_0/example.py
@@ -34,7 +34,7 @@ class Example(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"summary": "A foo example", "value": {"foo": "bar"}},
diff --git a/openapi_schema_pydantic/v3/v3_1_0/external_documentation.py b/openapi_schema_pydantic/v3/v3_1_0/external_documentation.py
@@ -19,5 +19,5 @@ class ExternalDocumentation(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {"examples": [{"description": "Find more info here", "url": "https://example.com"}]}
diff --git a/openapi_schema_pydantic/v3/v3_1_0/header.py b/openapi_schema_pydantic/v3/v3_1_0/header.py
@@ -17,7 +17,7 @@ class Header(Parameter):
     param_in = Field(default="header", const=True, alias="in")
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_1_0/info.py b/openapi_schema_pydantic/v3/v3_1_0/info.py
@@ -52,7 +52,7 @@ class Info(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/license.py b/openapi_schema_pydantic/v3/v3_1_0/license.py
@@ -27,7 +27,7 @@ class License(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"name": "Apache 2.0", "identifier": "Apache-2.0"},
diff --git a/openapi_schema_pydantic/v3/v3_1_0/link.py b/openapi_schema_pydantic/v3/v3_1_0/link.py
@@ -63,7 +63,7 @@ class Link(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {"operationId": "getUserAddressByUUID", "parameters": {"userUuid": "$response.body#/uuid"}},
diff --git a/openapi_schema_pydantic/v3/v3_1_0/media_type.py b/openapi_schema_pydantic/v3/v3_1_0/media_type.py
@@ -49,7 +49,7 @@ class MediaType(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_1_0/oauth_flow.py b/openapi_schema_pydantic/v3/v3_1_0/oauth_flow.py
@@ -39,7 +39,7 @@ class OAuthFlow(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/oauth_flows.py b/openapi_schema_pydantic/v3/v3_1_0/oauth_flows.py
@@ -35,4 +35,4 @@ class OAuthFlows(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
diff --git a/openapi_schema_pydantic/v3/v3_1_0/open_api.py b/openapi_schema_pydantic/v3/v3_1_0/open_api.py
@@ -87,4 +87,4 @@ class OpenAPI(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
diff --git a/openapi_schema_pydantic/v3/v3_1_0/operation.py b/openapi_schema_pydantic/v3/v3_1_0/operation.py
@@ -107,7 +107,7 @@ class Operation(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/parameter.py b/openapi_schema_pydantic/v3/v3_1_0/parameter.py
@@ -141,7 +141,7 @@ class Parameter(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_1_0/path_item.py b/openapi_schema_pydantic/v3/v3_1_0/path_item.py
@@ -93,7 +93,7 @@ class PathItem(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [
diff --git a/openapi_schema_pydantic/v3/v3_1_0/reference.py b/openapi_schema_pydantic/v3/v3_1_0/reference.py
@@ -30,7 +30,7 @@ class Reference(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         allow_population_by_field_name = True
         schema_extra = {
             "examples": [{"$ref": "#/components/schemas/Pet"}, {"$ref": "Pet.json"}, {"$ref": "definitions.json#/Pet"}]
diff --git a/openapi_schema_pydantic/v3/v3_1_0/request_body.py b/openapi_schema_pydantic/v3/v3_1_0/request_body.py
@@ -31,7 +31,7 @@ class RequestBody(BaseModel):
     """
 
     class Config:
-        extra = Extra.forbid
+        extra = Extra.ignore
         schema_extra = {
             "examples": [
                 {
diff --git a/openapi_schema_pydantic/v3/v3_1_0/response.py b/openapi_schema_pydantic/v3/v3_1_0/response.py
diff --git a/openapi_schema_pydantic/v3/v3_1_0/schema.py b/openapi_schema_pydantic/v3/v3_1_0/schema.py
diff --git a/openapi_schema_pydantic/v3/v3_1_0/security_scheme.py b/openapi_schema_pydantic/v3/v3_1_0/security_scheme.py
diff --git a/openapi_schema_pydantic/v3/v3_1_0/server.py b/openapi_schema_pydantic/v3/v3_1_0/server.py
diff --git a/openapi_schema_pydantic/v3/v3_1_0/server_variable.py b/openapi_schema_pydantic/v3/v3_1_0/server_variable.py
diff --git a/openapi_schema_pydantic/v3/v3_1_0/tag.py b/openapi_schema_pydantic/v3/v3_1_0/tag.py
diff --git a/openapi_schema_pydantic/v3/v3_1_0/xml.py b/openapi_schema_pydantic/v3/v3_1_0/xml.py

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.ignore`
`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.ignore`
`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.ignore`
`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.ignore`
`51`	`51`	`schema_extra = {`
`52`	`52`	`"examples": [`
`53`	`53`	`{`