@@ -609,7 +609,9 @@ 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 = [["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]],
612+ examples = [
613+ ["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]
614+ ],
613615 title = "Scopes" ,
614616 )
615617 token_expiry_date : Optional [str ] = Field (
@@ -1078,24 +1080,28 @@ class OAuthConfigSpecification(BaseModel):
10781080 class Config :
10791081 extra = Extra .allow
10801082
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" ,
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+ )
10941098 )
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" ,
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+ )
10991105 )
11001106 complete_oauth_output_specification : Optional [Dict [str , Any ]] = Field (
11011107 None ,
@@ -1113,7 +1119,9 @@ class Config:
11131119 complete_oauth_server_input_specification : Optional [Dict [str , Any ]] = Field (
11141120 None ,
11151121 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 }" ,
1116- examples = [{"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}],
1122+ examples = [
1123+ {"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}
1124+ ],
11171125 title = "OAuth input specification" ,
11181126 )
11191127 complete_oauth_server_output_specification : Optional [Dict [str , Any ]] = Field (
@@ -1744,7 +1752,9 @@ class RecordSelector(BaseModel):
17441752 description = "Responsible for filtering records to be emitted by the Source." ,
17451753 title = "Record Filter" ,
17461754 )
1747- schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
1755+ schema_normalization : Optional [
1756+ Union [SchemaNormalization , CustomSchemaNormalization ]
1757+ ] = Field (
17481758 SchemaNormalization .None_ ,
17491759 description = "Responsible for normalization according to the schema." ,
17501760 title = "Schema Normalization" ,
@@ -1948,12 +1958,16 @@ class Config:
19481958 description = "Component used to coordinate how records are extracted across stream slices and request pages." ,
19491959 title = "Retriever" ,
19501960 )
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" ,
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"
19551970 )
1956- name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
19571971 primary_key : Optional [PrimaryKey ] = Field (
19581972 "" , description = "The primary key of the stream." , title = "Primary Key"
19591973 )
@@ -2277,7 +2291,9 @@ class AsyncRetriever(BaseModel):
22772291 )
22782292 download_extractor : Optional [
22792293 Union [CustomRecordExtractor , DpathExtractor , ResponseToFileExtractor ]
2280- ] = Field (None , description = "Responsible for fetching the records from provided urls." )
2294+ ] = Field (
2295+ None , description = "Responsible for fetching the records from provided urls."
2296+ )
22812297 creation_requester : Union [CustomRequester , HttpRequester ] = Field (
22822298 ...,
22832299 description = "Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job." ,
@@ -2379,10 +2395,10 @@ class GroupingPartitionRouter(BaseModel):
23792395 examples = [10 , 50 ],
23802396 title = "Group Size" ,
23812397 )
2382- partition_router : Optional [
2383- Union [ CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter ]
2398+ underlying_partition_router : Union [
2399+ CustomPartitionRouter , ListPartitionRouter , SubstreamPartitionRouter
23842400 ] = Field (
2385- None ,
2401+ ... ,
23862402 description = "The partition router whose output will be grouped. This can be any valid partition router component." ,
23872403 title = "Underlying Partition Router" ,
23882404 )
@@ -2410,10 +2426,12 @@ class DynamicDeclarativeStream(BaseModel):
24102426 stream_template : DeclarativeStream = Field (
24112427 ..., description = "Reference to the stream template." , title = "Stream Template"
24122428 )
2413- components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = Field (
2414- ...,
2415- description = "Component resolve and populates stream templates with components values." ,
2416- title = "Components Resolver" ,
2429+ components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = (
2430+ Field (
2431+ ...,
2432+ description = "Component resolve and populates stream templates with components values." ,
2433+ title = "Components Resolver" ,
2434+ )
24172435 )
24182436
24192437
0 commit comments