@@ -618,9 +618,7 @@ 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 = [
622- ["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]
623- ],
621+ examples = [["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]],
624622 title = "Scopes" ,
625623 )
626624 token_expiry_date : Optional [str ] = Field (
@@ -1126,28 +1124,24 @@ class OAuthConfigSpecification(BaseModel):
11261124 class Config :
11271125 extra = Extra .allow
11281126
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- )
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" ,
11441140 )
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- )
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" ,
11511145 )
11521146 complete_oauth_output_specification : Optional [Dict [str , Any ]] = Field (
11531147 None ,
@@ -1165,9 +1159,7 @@ class Config:
11651159 complete_oauth_server_input_specification : Optional [Dict [str , Any ]] = Field (
11661160 None ,
11671161 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 }" ,
1168- examples = [
1169- {"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}
1170- ],
1162+ examples = [{"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}],
11711163 title = "OAuth input specification" ,
11721164 )
11731165 complete_oauth_server_output_specification : Optional [Dict [str , Any ]] = Field (
@@ -2013,9 +2005,7 @@ class RecordSelector(BaseModel):
20132005 description = "Responsible for filtering records to be emitted by the Source." ,
20142006 title = "Record Filter" ,
20152007 )
2016- schema_normalization : Optional [
2017- Union [SchemaNormalization , CustomSchemaNormalization ]
2018- ] = Field (
2008+ schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
20192009 None ,
20202010 description = "Responsible for normalization according to the schema." ,
20212011 title = "Schema Normalization" ,
@@ -2051,12 +2041,10 @@ class DpathValidator(BaseModel):
20512041 ],
20522042 title = "Field Path" ,
20532043 )
2054- validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = (
2055- Field (
2056- ...,
2057- description = "The condition that the specified config value will be evaluated against" ,
2058- title = "Validation Strategy" ,
2059- )
2044+ validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = Field (
2045+ ...,
2046+ description = "The condition that the specified config value will be evaluated against" ,
2047+ title = "Validation Strategy" ,
20602048 )
20612049
20622050
@@ -2073,12 +2061,10 @@ class PredicateValidator(BaseModel):
20732061 ],
20742062 title = "Value" ,
20752063 )
2076- validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = (
2077- Field (
2078- ...,
2079- description = "The validation strategy to apply to the value." ,
2080- title = "Validation Strategy" ,
2081- )
2064+ validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = Field (
2065+ ...,
2066+ description = "The validation strategy to apply to the value." ,
2067+ title = "Validation Strategy" ,
20822068 )
20832069
20842070
@@ -2161,9 +2147,7 @@ class ConfigMigration(BaseModel):
21612147 description : Optional [str ] = Field (
21622148 None , description = "The description/purpose of the config migration."
21632149 )
2164- transformations : List [
2165- Union [ConfigRemapField , ConfigAddFields , ConfigRemoveFields ]
2166- ] = Field (
2150+ transformations : List [Union [ConfigRemapField , ConfigAddFields , ConfigRemoveFields ]] = Field (
21672151 ...,
21682152 description = "The list of transformations that will attempt to be applied on an incoming unmigrated config. The transformations will be applied in the order they are defined." ,
21692153 title = "Transformations" ,
@@ -2255,9 +2239,9 @@ class Config:
22552239
22562240 type : Literal ["DeclarativeSource" ]
22572241 check : Union [CheckStream , CheckDynamicStream ]
2258- streams : Optional [
2259- List [ Union [ ConditionalStreams , DeclarativeStream , StateDelegatingStream ]]
2260- ] = None
2242+ streams : Optional [List [ Union [ ConditionalStreams , DeclarativeStream , StateDelegatingStream ]]] = (
2243+ None
2244+ )
22612245 dynamic_streams : List [DynamicDeclarativeStream ]
22622246 version : str = Field (
22632247 ...,
@@ -2382,9 +2366,7 @@ class Config:
23822366 extra = Extra .allow
23832367
23842368 type : Literal ["DeclarativeStream" ]
2385- name : Optional [str ] = Field (
2386- "" , description = "The stream name." , example = ["Users" ], title = "Name"
2387- )
2369+ name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
23882370 retriever : Union [SimpleRetriever , AsyncRetriever , CustomRetriever ] = Field (
23892371 ...,
23902372 description = "Component used to coordinate how records are extracted across stream slices and request pages." ,
@@ -2562,20 +2544,18 @@ class HttpRequester(BaseModelWithDeprecations):
25622544 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." ,
25632545 title = "Fetch Properties from Endpoint" ,
25642546 )
2565- request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = (
2566- Field (
2567- None ,
2568- description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2569- examples = [
2570- {"unit" : "day" },
2571- {
2572- "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2573- },
2574- {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2575- {"sort_by[asc]" : "updated_at" },
2576- ],
2577- title = "Query Parameters" ,
2578- )
2547+ request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = Field (
2548+ None ,
2549+ description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2550+ examples = [
2551+ {"unit" : "day" },
2552+ {
2553+ "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2554+ },
2555+ {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2556+ {"sort_by[asc]" : "updated_at" },
2557+ ],
2558+ title = "Query Parameters" ,
25792559 )
25802560 request_headers : Optional [Union [Dict [str , str ], str ]] = Field (
25812561 None ,
@@ -2770,9 +2750,7 @@ class QueryProperties(BaseModel):
27702750
27712751class StateDelegatingStream (BaseModel ):
27722752 type : Literal ["StateDelegatingStream" ]
2773- name : str = Field (
2774- ..., description = "The stream name." , example = ["Users" ], title = "Name"
2775- )
2753+ name : str = Field (..., description = "The stream name." , example = ["Users" ], title = "Name" )
27762754 full_refresh_stream : DeclarativeStream = Field (
27772755 ...,
27782756 description = "Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided." ,
@@ -2861,9 +2839,7 @@ class AsyncRetriever(BaseModel):
28612839 )
28622840 download_extractor : Optional [
28632841 Union [DpathExtractor , CustomRecordExtractor , ResponseToFileExtractor ]
2864- ] = Field (
2865- None , description = "Responsible for fetching the records from provided urls."
2866- )
2842+ ] = Field (None , description = "Responsible for fetching the records from provided urls." )
28672843 creation_requester : Union [HttpRequester , CustomRequester ] = Field (
28682844 ...,
28692845 description = "Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job." ,
0 commit comments