@@ -609,9 +609,7 @@ class OAuthAuthenticator(BaseModel):
609609 scopes : Optional [List [str ]] = Field (
610610 None ,
611611 description = "List of scopes that should be granted to the access token." ,
612- examples = [
613- ["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]
614- ],
612+ examples = [["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]],
615613 title = "Scopes" ,
616614 )
617615 token_expiry_date : Optional [str ] = Field (
@@ -1080,28 +1078,24 @@ class OAuthConfigSpecification(BaseModel):
10801078 class Config :
10811079 extra = Extra .allow
10821080
1083- oauth_user_input_from_connector_config_specification : Optional [Dict [str , Any ]] = (
1084- Field (
1085- None ,
1086- description = "OAuth specific blob. This is a Json Schema used to validate Json configurations used as input to OAuth.\n Must be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification\n using special annotation 'path_in_connector_config'.\n These are input values the user is entering through the UI to authenticate to the connector, that might also shared\n as inputs for syncing data via the connector.\n Examples:\n if no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[]\n if connector values such as 'app_id' inside the top level are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['app_id']\n }\n }\n if connector values such as 'info.app_id' nested inside another object are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['info', 'app_id']\n }\n }" ,
1087- examples = [
1088- {"app_id" : {"type" : "string" , "path_in_connector_config" : ["app_id" ]}},
1089- {
1090- "app_id" : {
1091- "type" : "string" ,
1092- "path_in_connector_config" : ["info" , "app_id" ],
1093- }
1094- },
1095- ],
1096- title = "OAuth user input" ,
1097- )
1081+ oauth_user_input_from_connector_config_specification : Optional [Dict [str , Any ]] = Field (
1082+ None ,
1083+ description = "OAuth specific blob. This is a Json Schema used to validate Json configurations used as input to OAuth.\n Must be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification\n using special annotation 'path_in_connector_config'.\n These are input values the user is entering through the UI to authenticate to the connector, that might also shared\n as inputs for syncing data via the connector.\n Examples:\n if no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[]\n if connector values such as 'app_id' inside the top level are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['app_id']\n }\n }\n if connector values such as 'info.app_id' nested inside another object are used to generate the API url for the oauth flow,\n oauth_user_input_from_connector_config_specification={\n app_id: {\n type: string\n path_in_connector_config: ['info', 'app_id']\n }\n }" ,
1084+ examples = [
1085+ {"app_id" : {"type" : "string" , "path_in_connector_config" : ["app_id" ]}},
1086+ {
1087+ "app_id" : {
1088+ "type" : "string" ,
1089+ "path_in_connector_config" : ["info" , "app_id" ],
1090+ }
1091+ },
1092+ ],
1093+ title = "OAuth user input" ,
10981094 )
1099- oauth_connector_input_specification : Optional [OauthConnectorInputSpecification ] = (
1100- Field (
1101- None ,
1102- description = 'The DeclarativeOAuth specific blob.\n Pertains to the fields defined by the connector relating to the OAuth flow.\n \n Interpolation capabilities:\n - The variables placeholders are declared as `{{my_var}}`.\n - The nested resolution variables like `{{ {{my_nested_var}} }}` is allowed as well.\n \n - The allowed interpolation context is:\n + base64Encoder - encode to `base64`, {{ {{my_var_a}}:{{my_var_b}} | base64Encoder }}\n + base64Decorer - decode from `base64` encoded string, {{ {{my_string_variable_or_string_value}} | base64Decoder }}\n + urlEncoder - encode the input string to URL-like format, {{ https://test.host.com/endpoint | urlEncoder}}\n + urlDecorer - decode the input url-encoded string into text format, {{ urlDecoder:https%3A%2F%2Fairbyte.io | urlDecoder}}\n + codeChallengeS256 - get the `codeChallenge` encoded value to provide additional data-provider specific authorisation values, {{ {{state_value}} | codeChallengeS256 }}\n \n Examples:\n - The TikTok Marketing DeclarativeOAuth spec:\n {\n "oauth_connector_input_specification": {\n "type": "object",\n "additionalProperties": false,\n "properties": {\n "consent_url": "https://ads.tiktok.com/marketing_api/auth?{{client_id_key}}={{client_id_value}}&{{redirect_uri_key}}={{ {{redirect_uri_value}} | urlEncoder}}&{{state_key}}={{state_value}}",\n "access_token_url": "https://business-api.tiktok.com/open_api/v1.3/oauth2/access_token/",\n "access_token_params": {\n "{{ auth_code_key }}": "{{ auth_code_value }}",\n "{{ client_id_key }}": "{{ client_id_value }}",\n "{{ client_secret_key }}": "{{ client_secret_value }}"\n },\n "access_token_headers": {\n "Content-Type": "application/json",\n "Accept": "application/json"\n },\n "extract_output": ["data.access_token"],\n "client_id_key": "app_id",\n "client_secret_key": "secret",\n "auth_code_key": "auth_code"\n }\n }\n }' ,
1103- title = "DeclarativeOAuth Connector Specification" ,
1104- )
1095+ oauth_connector_input_specification : Optional [OauthConnectorInputSpecification ] = Field (
1096+ None ,
1097+ description = 'The DeclarativeOAuth specific blob.\n Pertains to the fields defined by the connector relating to the OAuth flow.\n \n Interpolation capabilities:\n - The variables placeholders are declared as `{{my_var}}`.\n - The nested resolution variables like `{{ {{my_nested_var}} }}` is allowed as well.\n \n - The allowed interpolation context is:\n + base64Encoder - encode to `base64`, {{ {{my_var_a}}:{{my_var_b}} | base64Encoder }}\n + base64Decorer - decode from `base64` encoded string, {{ {{my_string_variable_or_string_value}} | base64Decoder }}\n + urlEncoder - encode the input string to URL-like format, {{ https://test.host.com/endpoint | urlEncoder}}\n + urlDecorer - decode the input url-encoded string into text format, {{ urlDecoder:https%3A%2F%2Fairbyte.io | urlDecoder}}\n + codeChallengeS256 - get the `codeChallenge` encoded value to provide additional data-provider specific authorisation values, {{ {{state_value}} | codeChallengeS256 }}\n \n Examples:\n - The TikTok Marketing DeclarativeOAuth spec:\n {\n "oauth_connector_input_specification": {\n "type": "object",\n "additionalProperties": false,\n "properties": {\n "consent_url": "https://ads.tiktok.com/marketing_api/auth?{{client_id_key}}={{client_id_value}}&{{redirect_uri_key}}={{ {{redirect_uri_value}} | urlEncoder}}&{{state_key}}={{state_value}}",\n "access_token_url": "https://business-api.tiktok.com/open_api/v1.3/oauth2/access_token/",\n "access_token_params": {\n "{{ auth_code_key }}": "{{ auth_code_value }}",\n "{{ client_id_key }}": "{{ client_id_value }}",\n "{{ client_secret_key }}": "{{ client_secret_value }}"\n },\n "access_token_headers": {\n "Content-Type": "application/json",\n "Accept": "application/json"\n },\n "extract_output": ["data.access_token"],\n "client_id_key": "app_id",\n "client_secret_key": "secret",\n "auth_code_key": "auth_code"\n }\n }\n }' ,
1098+ title = "DeclarativeOAuth Connector Specification" ,
11051099 )
11061100 complete_oauth_output_specification : Optional [Dict [str , Any ]] = Field (
11071101 None ,
@@ -1119,9 +1113,7 @@ class Config:
11191113 complete_oauth_server_input_specification : Optional [Dict [str , Any ]] = Field (
11201114 None ,
11211115 description = "OAuth specific blob. This is a Json Schema used to validate Json configurations persisted as Airbyte Server configurations.\n Must be a valid non-nested JSON describing additional fields configured by the Airbyte Instance or Workspace Admins to be used by the\n server when completing an OAuth flow (typically exchanging an auth code for refresh token).\n Examples:\n complete_oauth_server_input_specification={\n client_id: {\n type: string\n },\n client_secret: {\n type: string\n }\n }" ,
1122- examples = [
1123- {"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}
1124- ],
1116+ examples = [{"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}],
11251117 title = "OAuth input specification" ,
11261118 )
11271119 complete_oauth_server_output_specification : Optional [Dict [str , Any ]] = Field (
@@ -1774,9 +1766,7 @@ class RecordSelector(BaseModel):
17741766 description = "Responsible for filtering records to be emitted by the Source." ,
17751767 title = "Record Filter" ,
17761768 )
1777- schema_normalization : Optional [
1778- Union [SchemaNormalization , CustomSchemaNormalization ]
1779- ] = Field (
1769+ schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
17801770 SchemaNormalization .None_ ,
17811771 description = "Responsible for normalization according to the schema." ,
17821772 title = "Schema Normalization" ,
@@ -1991,9 +1981,7 @@ class Config:
19911981 description = "Component used to fetch data incrementally based on a time field in the data." ,
19921982 title = "Incremental Sync" ,
19931983 )
1994- name : Optional [str ] = Field (
1995- "" , description = "The stream name." , example = ["Users" ], title = "Name"
1996- )
1984+ name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
19971985 primary_key : Optional [PrimaryKey ] = Field (
19981986 "" , description = "The primary key of the stream." , title = "Primary Key"
19991987 )
@@ -2267,11 +2255,7 @@ class SimpleRetriever(BaseModel):
22672255 CustomPartitionRouter ,
22682256 ListPartitionRouter ,
22692257 SubstreamPartitionRouter ,
2270- List [
2271- Union [
2272- CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter
2273- ]
2274- ],
2258+ List [Union [CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter ]],
22752259 ]
22762260 ] = Field (
22772261 [],
@@ -2315,9 +2299,7 @@ class AsyncRetriever(BaseModel):
23152299 )
23162300 download_extractor : Optional [
23172301 Union [CustomRecordExtractor , DpathExtractor , ResponseToFileExtractor ]
2318- ] = Field (
2319- None , description = "Responsible for fetching the records from provided urls."
2320- )
2302+ ] = Field (None , description = "Responsible for fetching the records from provided urls." )
23212303 creation_requester : Union [CustomRequester , HttpRequester ] = Field (
23222304 ...,
23232305 description = "Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job." ,
@@ -2351,11 +2333,7 @@ class AsyncRetriever(BaseModel):
23512333 CustomPartitionRouter ,
23522334 ListPartitionRouter ,
23532335 SubstreamPartitionRouter ,
2354- List [
2355- Union [
2356- CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter
2357- ]
2358- ],
2336+ List [Union [CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter ]],
23592337 ]
23602338 ] = Field (
23612339 [],
@@ -2423,12 +2401,10 @@ class DynamicDeclarativeStream(BaseModel):
24232401 stream_template : DeclarativeStream = Field (
24242402 ..., description = "Reference to the stream template." , title = "Stream Template"
24252403 )
2426- components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = (
2427- Field (
2428- ...,
2429- description = "Component resolve and populates stream templates with components values." ,
2430- title = "Components Resolver" ,
2431- )
2404+ components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = Field (
2405+ ...,
2406+ description = "Component resolve and populates stream templates with components values." ,
2407+ title = "Components Resolver" ,
24322408 )
24332409
24342410
0 commit comments