Merge pull request #10 from kuimono/5-update-url-field-types

Fix issue #5 for url types in `SecurityScheme`, `OAuthFlow`

Author: kuimono

openapi_schema_pydantic/v3/v3_0_3/oauth_flow.py

@@ -1,4 +1,4 @@
-from typing import Dict, Optional
+from typing import Dict, Optional, Union
 
 from pydantic import AnyUrl, BaseModel, Extra
 
@@ -8,21 +8,21 @@ class OAuthFlow(BaseModel):
     Configuration details for a supported OAuth Flow
     """
 
-    authorizationUrl: Optional[AnyUrl] = None
+    authorizationUrl: Optional[Union[AnyUrl, str]] = None
     """
     **REQUIRED** for `oauth2 ("implicit", "authorizationCode")`.
     The authorization URL to be used for this flow.
     This MUST be in the form of a URL.
     """
 
-    tokenUrl: Optional[AnyUrl] = None
+    tokenUrl: Optional[Union[AnyUrl, str]] = None
     """
     **REQUIRED** for `oauth2 ("password", "clientCredentials", "authorizationCode")`.
     The token URL to be used for this flow.
     This MUST be in the form of a URL.
     """
 
-    refreshUrl: Optional[AnyUrl] = None
+    refreshUrl: Optional[Union[AnyUrl, str]] = None
     """
     The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
     """
@@ -47,5 +47,11 @@ class Config:
                     "tokenUrl": "https://example.com/api/oauth/token",
                     "scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
                 },
+                {
+                    "authorizationUrl": "/api/oauth/dialog",    # issue #5: allow relative path
+                    "tokenUrl": "/api/oauth/token",             # issue #5: allow relative path
+                    "refreshUrl": "/api/oauth/token",           # issue #5: allow relative path
+                    "scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
+                },
             ]
         }

openapi_schema_pydantic/v3/v3_0_3/security_scheme.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, Union
 
 from pydantic import AnyUrl, BaseModel, Extra, Field
 
@@ -32,7 +32,7 @@ class SecurityScheme(BaseModel):
     **REQUIRED** for `apiKey`. The name of the header, query or cookie parameter to be used.
     """
 
-    security_scheme_in: Optional[str] = Field(alias="in")
+    security_scheme_in: Optional[str] = Field(alias="in", default=None)
     """
     **REQUIRED** for `apiKey`. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`.
     """
@@ -59,7 +59,7 @@ class SecurityScheme(BaseModel):
     **REQUIRED** for `oauth2`. An object containing configuration information for the flow types supported.
     """
 
-    openIdConnectUrl: Optional[AnyUrl] = None
+    openIdConnectUrl: Optional[Union[AnyUrl, str]] = None
     """
     **REQUIRED** for `openIdConnect`. OpenId Connect URL to discover OAuth2 configuration values.
     This MUST be in the form of a URL.
@@ -82,5 +82,7 @@ class Config:
                         }
                     },
                 },
+                {"type": "openIdConnect", "openIdConnectUrl": "https://example.com/openIdConnect"},
+                {"type": "openIdConnect", "openIdConnectUrl": "openIdConnect"},     # #5: allow relative path
             ]
         }

openapi_schema_pydantic/v3/v3_1_0/oauth_flow.py

@@ -1,4 +1,4 @@
-from typing import Dict, Optional
+from typing import Dict, Optional, Union
 
 from pydantic import AnyUrl, BaseModel, Extra
 
@@ -8,23 +8,23 @@ class OAuthFlow(BaseModel):
     Configuration details for a supported OAuth Flow
     """
 
-    authorizationUrl: Optional[AnyUrl] = None
+    authorizationUrl: Optional[Union[AnyUrl, str]] = None
     """
     **REQUIRED** for `oauth2 ("implicit", "authorizationCode")`.
     The authorization URL to be used for this flow.
     This MUST be in the form of a URL.
     The OAuth2 standard requires the use of TLS.
     """
 
-    tokenUrl: Optional[AnyUrl] = None
+    tokenUrl: Optional[Union[AnyUrl, str]] = None
     """
     **REQUIRED** for `oauth2 ("password", "clientCredentials", "authorizationCode")`.
     The token URL to be used for this flow.
     This MUST be in the form of a URL.
     The OAuth2 standard requires the use of TLS.
     """
 
-    refreshUrl: Optional[AnyUrl] = None
+    refreshUrl: Optional[Union[AnyUrl, str]] = None
     """
     The URL to be used for obtaining refresh tokens.
     This MUST be in the form of a URL.
@@ -51,5 +51,11 @@ class Config:
                     "tokenUrl": "https://example.com/api/oauth/token",
                     "scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
                 },
+                {
+                    "authorizationUrl": "/api/oauth/dialog",  # issue #5: allow relative path
+                    "tokenUrl": "/api/oauth/token",  # issue #5: allow relative path
+                    "refreshUrl": "/api/oauth/token",  # issue #5: allow relative path
+                    "scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
+                },
             ]
         }

openapi_schema_pydantic/v3/v3_1_0/security_scheme.py

@@ -1,4 +1,4 @@
-from typing import Optional
+from typing import Optional, Union
 
 from pydantic import AnyUrl, BaseModel, Extra, Field
 
@@ -38,7 +38,7 @@ class SecurityScheme(BaseModel):
     **REQUIRED** for `apiKey`. The name of the header, query or cookie parameter to be used.
     """
 
-    security_scheme_in: Optional[str] = Field(alias="in")
+    security_scheme_in: Optional[str] = Field(alias="in", default=None)
     """
     **REQUIRED** for `apiKey`. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`.
     """
@@ -65,7 +65,7 @@ class SecurityScheme(BaseModel):
     **REQUIRED** for `oauth2`. An object containing configuration information for the flow types supported.
     """
 
-    openIdConnectUrl: Optional[AnyUrl] = None
+    openIdConnectUrl: Optional[Union[AnyUrl, str]] = None
     """
     **REQUIRED** for `openIdConnect`. OpenId Connect URL to discover OAuth2 configuration values.
     This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS.
@@ -88,5 +88,7 @@ class Config:
                         }
                     },
                 },
+                {"type": "openIdConnect", "openIdConnectUrl": "https://example.com/openIdConnect"},
+                {"type": "openIdConnect", "openIdConnectUrl": "openIdConnect"},  # issue #5: allow relative path
             ]
         }

tests/schema_classes/__init__.py

@@ -0,0 +1,25 @@
+from pydantic import AnyUrl
+
+from openapi_schema_pydantic import SecurityScheme
+
+
+def test_security_scheme_issue_5():
+    """https://github.com/kuimono/openapi-schema-pydantic/issues/5"""
+
+    security_scheme_1 = SecurityScheme(type="openIdConnect", openIdConnectUrl="https://example.com/openIdConnect")
+    assert isinstance(security_scheme_1.openIdConnectUrl, AnyUrl)
+    assert security_scheme_1.json(by_alias=True, exclude_none=True) == (
+        '{"type": "openIdConnect", "openIdConnectUrl": "https://example.com/openIdConnect"}'
+    )
+
+    security_scheme_2 = SecurityScheme(type="openIdConnect", openIdConnectUrl="/openIdConnect")
+    assert isinstance(security_scheme_2.openIdConnectUrl, str)
+    assert security_scheme_2.json(by_alias=True, exclude_none=True) == (
+        '{"type": "openIdConnect", "openIdConnectUrl": "/openIdConnect"}'
+    )
+
+    security_scheme_3 = SecurityScheme(type="openIdConnect", openIdConnectUrl="openIdConnect")
+    assert isinstance(security_scheme_3.openIdConnectUrl, str)
+    assert security_scheme_3.json(by_alias=True, exclude_none=True) == (
+        '{"type": "openIdConnect", "openIdConnectUrl": "openIdConnect"}'
+    )