@@ -618,7 +618,9 @@ class OAuthAuthenticator(BaseModel):
618618 scopes : Optional [List [str ]] = Field (
619619 None ,
620620 description = "List of scopes that should be granted to the access token." ,
621- examples = [["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]],
621+ examples = [
622+ ["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]
623+ ],
622624 title = "Scopes" ,
623625 )
624626 token_expiry_date : Optional [str ] = Field (
@@ -1124,24 +1126,28 @@ class OAuthConfigSpecification(BaseModel):
11241126 class Config :
11251127 extra = Extra .allow
11261128
1127- oauth_user_input_from_connector_config_specification : Optional [Dict [str , Any ]] = Field (
1128- None ,
1129- 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 }" ,
1130- examples = [
1131- {"app_id" : {"type" : "string" , "path_in_connector_config" : ["app_id" ]}},
1132- {
1133- "app_id" : {
1134- "type" : "string" ,
1135- "path_in_connector_config" : ["info" , "app_id" ],
1136- }
1137- },
1138- ],
1139- title = "OAuth user input" ,
1129+ oauth_user_input_from_connector_config_specification : Optional [Dict [str , Any ]] = (
1130+ Field (
1131+ None ,
1132+ 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 }" ,
1133+ examples = [
1134+ {"app_id" : {"type" : "string" , "path_in_connector_config" : ["app_id" ]}},
1135+ {
1136+ "app_id" : {
1137+ "type" : "string" ,
1138+ "path_in_connector_config" : ["info" , "app_id" ],
1139+ }
1140+ },
1141+ ],
1142+ title = "OAuth user input" ,
1143+ )
11401144 )
1141- oauth_connector_input_specification : Optional [OauthConnectorInputSpecification ] = Field (
1142- None ,
1143- 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 }' ,
1144- title = "DeclarativeOAuth Connector Specification" ,
1145+ oauth_connector_input_specification : Optional [OauthConnectorInputSpecification ] = (
1146+ Field (
1147+ None ,
1148+ 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 }' ,
1149+ title = "DeclarativeOAuth Connector Specification" ,
1150+ )
11451151 )
11461152 complete_oauth_output_specification : Optional [Dict [str , Any ]] = Field (
11471153 None ,
@@ -1159,7 +1165,9 @@ class Config:
11591165 complete_oauth_server_input_specification : Optional [Dict [str , Any ]] = Field (
11601166 None ,
11611167 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 }" ,
1162- examples = [{"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}],
1168+ examples = [
1169+ {"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}
1170+ ],
11631171 title = "OAuth input specification" ,
11641172 )
11651173 complete_oauth_server_output_specification : Optional [Dict [str , Any ]] = Field (
@@ -1521,10 +1529,6 @@ class Config:
15211529 query : Dict [str , Any ] = Field (..., description = "The GraphQL query to be executed" )
15221530
15231531
1524- class KeyValueExtractor (BaseModel ):
1525- __root__ : Any
1526-
1527-
15281532class AddedFieldDefinition (BaseModel ):
15291533 type : Literal ["AddedFieldDefinition" ]
15301534 path : List [str ] = Field (
@@ -1849,7 +1853,7 @@ class DefaultPaginator(BaseModel):
18491853class CombinedExtractor (BaseModel ):
18501854 type : Literal ["CombinedExtractor" ]
18511855 extractors : List [
1852- Union [DpathExtractor , CombinedExtractor , KeyValueExtractor , CustomRecordExtractor ]
1856+ Union [DpathExtractor , CombinedExtractor , CustomRecordExtractor ]
18531857 ] = Field (..., description = "placeholder" )
18541858 parameters : Optional [Dict [str , Any ]] = Field (None , alias = "$parameters" )
18551859
@@ -1897,7 +1901,9 @@ class RecordSelector(BaseModel):
18971901 description = "Responsible for filtering records to be emitted by the Source." ,
18981902 title = "Record Filter" ,
18991903 )
1900- schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
1904+ schema_normalization : Optional [
1905+ Union [SchemaNormalization , CustomSchemaNormalization ]
1906+ ] = Field (
19011907 None ,
19021908 description = "Responsible for normalization according to the schema." ,
19031909 title = "Schema Normalization" ,
@@ -2143,7 +2149,9 @@ class Config:
21432149 extra = Extra .allow
21442150
21452151 type : Literal ["DeclarativeStream" ]
2146- name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
2152+ name : Optional [str ] = Field (
2153+ "" , description = "The stream name." , example = ["Users" ], title = "Name"
2154+ )
21472155 retriever : Union [SimpleRetriever , AsyncRetriever , CustomRetriever ] = Field (
21482156 ...,
21492157 description = "Component used to coordinate how records are extracted across stream slices and request pages." ,
@@ -2321,18 +2329,20 @@ class HttpRequester(BaseModelWithDeprecations):
23212329 description = "Allows for retrieving a dynamic set of properties from an API endpoint which can be injected into outbound request using the stream_partition.extra_fields." ,
23222330 title = "Fetch Properties from Endpoint" ,
23232331 )
2324- request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = Field (
2325- None ,
2326- description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2327- examples = [
2328- {"unit" : "day" },
2329- {
2330- "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2331- },
2332- {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2333- {"sort_by[asc]" : "updated_at" },
2334- ],
2335- title = "Query Parameters" ,
2332+ request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = (
2333+ Field (
2334+ None ,
2335+ description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2336+ examples = [
2337+ {"unit" : "day" },
2338+ {
2339+ "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2340+ },
2341+ {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2342+ {"sort_by[asc]" : "updated_at" },
2343+ ],
2344+ title = "Query Parameters" ,
2345+ )
23362346 )
23372347 request_headers : Optional [Union [Dict [str , str ], str ]] = Field (
23382348 None ,
@@ -2522,7 +2532,9 @@ class QueryProperties(BaseModel):
25222532
25232533class StateDelegatingStream (BaseModel ):
25242534 type : Literal ["StateDelegatingStream" ]
2525- name : str = Field (..., description = "The stream name." , example = ["Users" ], title = "Name" )
2535+ name : str = Field (
2536+ ..., description = "The stream name." , example = ["Users" ], title = "Name"
2537+ )
25262538 full_refresh_stream : DeclarativeStream = Field (
25272539 ...,
25282540 description = "Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided." ,
@@ -2611,7 +2623,9 @@ class AsyncRetriever(BaseModel):
26112623 )
26122624 download_extractor : Optional [
26132625 Union [DpathExtractor , CustomRecordExtractor , ResponseToFileExtractor ]
2614- ] = Field (None , description = "Responsible for fetching the records from provided urls." )
2626+ ] = Field (
2627+ None , description = "Responsible for fetching the records from provided urls."
2628+ )
26152629 creation_requester : Union [HttpRequester , CustomRequester ] = Field (
26162630 ...,
26172631 description = "Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job." ,
@@ -2751,10 +2765,12 @@ class DynamicDeclarativeStream(BaseModel):
27512765 stream_template : DeclarativeStream = Field (
27522766 ..., description = "Reference to the stream template." , title = "Stream Template"
27532767 )
2754- components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = Field (
2755- ...,
2756- description = "Component resolve and populates stream templates with components values." ,
2757- title = "Components Resolver" ,
2768+ components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = (
2769+ Field (
2770+ ...,
2771+ description = "Component resolve and populates stream templates with components values." ,
2772+ title = "Components Resolver" ,
2773+ )
27582774 )
27592775
27602776
0 commit comments