@@ -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 (
@@ -1752,9 +1744,7 @@ class RecordSelector(BaseModel):
17521744 description = "Responsible for filtering records to be emitted by the Source." ,
17531745 title = "Record Filter" ,
17541746 )
1755- schema_normalization : Optional [
1756- Union [SchemaNormalization , CustomSchemaNormalization ]
1757- ] = Field (
1747+ schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
17581748 SchemaNormalization .None_ ,
17591749 description = "Responsible for normalization according to the schema." ,
17601750 title = "Schema Normalization" ,
@@ -1958,16 +1948,12 @@ class Config:
19581948 description = "Component used to coordinate how records are extracted across stream slices and request pages." ,
19591949 title = "Retriever" ,
19601950 )
1961- incremental_sync : Optional [Union [CustomIncrementalSync , DatetimeBasedCursor ]] = (
1962- Field (
1963- None ,
1964- description = "Component used to fetch data incrementally based on a time field in the data." ,
1965- title = "Incremental Sync" ,
1966- )
1967- )
1968- name : Optional [str ] = Field (
1969- "" , description = "The stream name." , example = ["Users" ], title = "Name"
1951+ incremental_sync : Optional [Union [CustomIncrementalSync , DatetimeBasedCursor ]] = Field (
1952+ None ,
1953+ description = "Component used to fetch data incrementally based on a time field in the data." ,
1954+ title = "Incremental Sync" ,
19701955 )
1956+ name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
19711957 primary_key : Optional [PrimaryKey ] = Field (
19721958 "" , description = "The primary key of the stream." , title = "Primary Key"
19731959 )
@@ -2239,11 +2225,7 @@ class SimpleRetriever(BaseModel):
22392225 CustomPartitionRouter ,
22402226 ListPartitionRouter ,
22412227 SubstreamPartitionRouter ,
2242- List [
2243- Union [
2244- CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter
2245- ]
2246- ],
2228+ List [Union [CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter ]],
22472229 ]
22482230 ] = Field (
22492231 [],
@@ -2287,9 +2269,7 @@ class AsyncRetriever(BaseModel):
22872269 )
22882270 download_extractor : Optional [
22892271 Union [CustomRecordExtractor , DpathExtractor , ResponseToFileExtractor ]
2290- ] = Field (
2291- None , description = "Responsible for fetching the records from provided urls."
2292- )
2272+ ] = Field (None , description = "Responsible for fetching the records from provided urls." )
22932273 creation_requester : Union [CustomRequester , HttpRequester ] = Field (
22942274 ...,
22952275 description = "Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job." ,
@@ -2323,11 +2303,7 @@ class AsyncRetriever(BaseModel):
23232303 CustomPartitionRouter ,
23242304 ListPartitionRouter ,
23252305 SubstreamPartitionRouter ,
2326- List [
2327- Union [
2328- CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter
2329- ]
2330- ],
2306+ List [Union [CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter ]],
23312307 ]
23322308 ] = Field (
23332309 [],
@@ -2395,12 +2371,10 @@ class DynamicDeclarativeStream(BaseModel):
23952371 stream_template : DeclarativeStream = Field (
23962372 ..., description = "Reference to the stream template." , title = "Stream Template"
23972373 )
2398- components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = (
2399- Field (
2400- ...,
2401- description = "Component resolve and populates stream templates with components values." ,
2402- title = "Components Resolver" ,
2403- )
2374+ components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = Field (
2375+ ...,
2376+ description = "Component resolve and populates stream templates with components values." ,
2377+ title = "Components Resolver" ,
24042378 )
24052379
24062380
0 commit comments