forked from openapi-generators/openapi-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathoauth_flow.py
More file actions
50 lines (42 loc) · 1.54 KB
/
oauth_flow.py
File metadata and controls
50 lines (42 loc) · 1.54 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
from typing import Dict, Optional
from pydantic import AnyUrl, BaseModel
class OAuthFlow(BaseModel):
"""
Configuration details for a supported OAuth Flow
"""
authorizationUrl: Optional[AnyUrl] = 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[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
"""
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
"""
scopes: Dict[str, str]
"""
**REQUIRED**. The available scopes for the OAuth2 security scheme.
A map between the scope name and a short description for it.
The map MAY be empty.
"""
class Config:
schema_extra = {
"examples": [
{
"authorizationUrl": "https://example.com/api/oauth/dialog",
"scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
},
{
"authorizationUrl": "https://example.com/api/oauth/dialog",
"tokenUrl": "https://example.com/api/oauth/token",
"scopes": {"write:pets": "modify pets in your account", "read:pets": "read your pets"},
},
]
}