@@ -926,28 +926,24 @@ class OAuthConfigSpecification(BaseModel):
926926 class Config :
927927 extra = Extra .allow
928928
929- oauth_user_input_from_connector_config_specification : Optional [Dict [str , Any ]] = (
930- Field (
931- None ,
932- 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 }" ,
933- examples = [
934- {"app_id" : {"type" : "string" , "path_in_connector_config" : ["app_id" ]}},
935- {
936- "app_id" : {
937- "type" : "string" ,
938- "path_in_connector_config" : ["info" , "app_id" ],
939- }
940- },
941- ],
942- title = "OAuth user input" ,
943- )
929+ oauth_user_input_from_connector_config_specification : Optional [Dict [str , Any ]] = Field (
930+ None ,
931+ 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 }" ,
932+ examples = [
933+ {"app_id" : {"type" : "string" , "path_in_connector_config" : ["app_id" ]}},
934+ {
935+ "app_id" : {
936+ "type" : "string" ,
937+ "path_in_connector_config" : ["info" , "app_id" ],
938+ }
939+ },
940+ ],
941+ title = "OAuth user input" ,
944942 )
945- oauth_connector_input_specification : Optional [OauthConnectorInputSpecification ] = (
946- Field (
947- None ,
948- 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 }' ,
949- title = "DeclarativeOAuth Connector Specification" ,
950- )
943+ oauth_connector_input_specification : Optional [OauthConnectorInputSpecification ] = Field (
944+ None ,
945+ 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 }' ,
946+ title = "DeclarativeOAuth Connector Specification" ,
951947 )
952948 complete_oauth_output_specification : Optional [Dict [str , Any ]] = Field (
953949 None ,
@@ -965,9 +961,7 @@ class Config:
965961 complete_oauth_server_input_specification : Optional [Dict [str , Any ]] = Field (
966962 None ,
967963 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 }" ,
968- examples = [
969- {"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}
970- ],
964+ examples = [{"client_id" : {"type" : "string" }, "client_secret" : {"type" : "string" }}],
971965 title = "OAuth input specification" ,
972966 )
973967 complete_oauth_server_output_specification : Optional [Dict [str , Any ]] = Field (
@@ -1471,9 +1465,7 @@ class CustomConfigTransformation(BaseModel):
14711465 class_name : str = Field (
14721466 ...,
14731467 description = "Fully-qualified name of the class that will be implementing the custom config transformation. The format is `source_<name>.<package>.<class_name>`." ,
1474- examples = [
1475- "source_declarative_manifest.components.MyCustomConfigTransformation"
1476- ],
1468+ examples = ["source_declarative_manifest.components.MyCustomConfigTransformation" ],
14771469 )
14781470 parameters : Optional [Dict [str , Any ]] = Field (
14791471 None ,
@@ -1901,9 +1893,7 @@ class OAuthAuthenticator(BaseModel):
19011893 scopes : Optional [List [str ]] = Field (
19021894 None ,
19031895 description = "List of scopes that should be granted to the access token." ,
1904- examples = [
1905- ["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]
1906- ],
1896+ examples = [["crm.list.read" , "crm.objects.contacts.read" , "crm.schema.contacts.read" ]],
19071897 title = "Scopes" ,
19081898 )
19091899 scopes_name : Optional [str ] = Field (
@@ -2136,9 +2126,7 @@ class RecordSelector(BaseModel):
21362126 description = "Responsible for filtering records to be emitted by the Source." ,
21372127 title = "Record Filter" ,
21382128 )
2139- schema_normalization : Optional [
2140- Union [SchemaNormalization , CustomSchemaNormalization ]
2141- ] = Field (
2129+ schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
21422130 None ,
21432131 description = "Responsible for normalization according to the schema." ,
21442132 title = "Schema Normalization" ,
@@ -2180,12 +2168,10 @@ class DpathValidator(BaseModel):
21802168 ],
21812169 title = "Field Path" ,
21822170 )
2183- validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = (
2184- Field (
2185- ...,
2186- description = "The condition that the specified config value will be evaluated against" ,
2187- title = "Validation Strategy" ,
2188- )
2171+ validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = Field (
2172+ ...,
2173+ description = "The condition that the specified config value will be evaluated against" ,
2174+ title = "Validation Strategy" ,
21892175 )
21902176
21912177
@@ -2202,12 +2188,10 @@ class PredicateValidator(BaseModel):
22022188 ],
22032189 title = "Value" ,
22042190 )
2205- validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = (
2206- Field (
2207- ...,
2208- description = "The validation strategy to apply to the value." ,
2209- title = "Validation Strategy" ,
2210- )
2191+ validation_strategy : Union [ValidateAdheresToSchema , CustomValidationStrategy ] = Field (
2192+ ...,
2193+ description = "The validation strategy to apply to the value." ,
2194+ title = "Validation Strategy" ,
22112195 )
22122196
22132197
@@ -2232,12 +2216,12 @@ class ConfigAddFields(BaseModel):
22322216
22332217class CompositeErrorHandler (BaseModel ):
22342218 type : Literal ["CompositeErrorHandler" ]
2235- error_handlers : List [
2236- Union [ CompositeErrorHandler , DefaultErrorHandler , CustomErrorHandler ]
2237- ] = Field (
2238- ... ,
2239- description = "List of error handlers to iterate on to determine how to handle a failed response. " ,
2240- title = "Error Handlers" ,
2219+ error_handlers : List [Union [ CompositeErrorHandler , DefaultErrorHandler , CustomErrorHandler ]] = (
2220+ Field (
2221+ ...,
2222+ description = "List of error handlers to iterate on to determine how to handle a failed response." ,
2223+ title = "Error Handlers " ,
2224+ )
22412225 )
22422226 parameters : Optional [Dict [str , Any ]] = Field (None , alias = "$parameters" )
22432227
@@ -2399,9 +2383,9 @@ class Config:
23992383
24002384 type : Literal ["DeclarativeSource" ]
24012385 check : Union [CheckStream , CheckDynamicStream ]
2402- streams : Optional [
2403- List [ Union [ ConditionalStreams , DeclarativeStream , StateDelegatingStream ]]
2404- ] = None
2386+ streams : Optional [List [ Union [ ConditionalStreams , DeclarativeStream , StateDelegatingStream ]]] = (
2387+ None
2388+ )
24052389 dynamic_streams : List [DynamicDeclarativeStream ]
24062390 version : str = Field (
24072391 ...,
@@ -2526,20 +2510,16 @@ class Config:
25262510 extra = Extra .allow
25272511
25282512 type : Literal ["DeclarativeStream" ]
2529- name : Optional [str ] = Field (
2530- "" , description = "The stream name." , example = ["Users" ], title = "Name"
2531- )
2513+ name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
25322514 retriever : Union [SimpleRetriever , AsyncRetriever , CustomRetriever ] = Field (
25332515 ...,
25342516 description = "Component used to coordinate how records are extracted across stream slices and request pages." ,
25352517 title = "Retriever" ,
25362518 )
2537- incremental_sync : Optional [Union [DatetimeBasedCursor , IncrementingCountCursor ]] = (
2538- Field (
2539- None ,
2540- description = "Component used to fetch data incrementally based on a time field in the data." ,
2541- title = "Incremental Sync" ,
2542- )
2519+ incremental_sync : Optional [Union [DatetimeBasedCursor , IncrementingCountCursor ]] = Field (
2520+ None ,
2521+ description = "Component used to fetch data incrementally based on a time field in the data." ,
2522+ title = "Incremental Sync" ,
25432523 )
25442524 primary_key : Optional [PrimaryKey ] = Field ("" , title = "Primary Key" )
25452525 schema_loader : Optional [
@@ -2713,20 +2693,18 @@ class HttpRequester(BaseModelWithDeprecations):
27132693 description = "For APIs that require explicit specification of the properties to query for, this component will take a static or dynamic set of properties (which can be optionally split into chunks) and allow them to be injected into an outbound request by accessing stream_partition.extra_fields." ,
27142694 title = "Query Properties" ,
27152695 )
2716- request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = (
2717- Field (
2718- None ,
2719- description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2720- examples = [
2721- {"unit" : "day" },
2722- {
2723- "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2724- },
2725- {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2726- {"sort_by[asc]" : "updated_at" },
2727- ],
2728- title = "Query Parameters" ,
2729- )
2696+ request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = Field (
2697+ None ,
2698+ description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2699+ examples = [
2700+ {"unit" : "day" },
2701+ {
2702+ "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2703+ },
2704+ {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2705+ {"sort_by[asc]" : "updated_at" },
2706+ ],
2707+ title = "Query Parameters" ,
27302708 )
27312709 request_headers : Optional [Union [Dict [str , str ], str ]] = Field (
27322710 None ,
@@ -2898,9 +2876,7 @@ class QueryProperties(BaseModel):
28982876
28992877class StateDelegatingStream (BaseModel ):
29002878 type : Literal ["StateDelegatingStream" ]
2901- name : str = Field (
2902- ..., description = "The stream name." , example = ["Users" ], title = "Name"
2903- )
2879+ name : str = Field (..., description = "The stream name." , example = ["Users" ], title = "Name" )
29042880 full_refresh_stream : DeclarativeStream = Field (
29052881 ...,
29062882 description = "Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided." ,
@@ -2987,17 +2963,13 @@ class AsyncRetriever(BaseModel):
29872963 status_extractor : Union [DpathExtractor , CustomRecordExtractor ] = Field (
29882964 ..., description = "Responsible for fetching the actual status of the async job."
29892965 )
2990- download_target_extractor : Optional [
2991- Union [DpathExtractor , CustomRecordExtractor ]
2992- ] = Field (
2966+ download_target_extractor : Optional [Union [DpathExtractor , CustomRecordExtractor ]] = Field (
29932967 None ,
29942968 description = "Responsible for fetching the final result `urls` provided by the completed / finished / ready async job." ,
29952969 )
29962970 download_extractor : Optional [
29972971 Union [DpathExtractor , CustomRecordExtractor , ResponseToFileExtractor ]
2998- ] = Field (
2999- None , description = "Responsible for fetching the records from provided urls."
3000- )
2972+ ] = Field (None , description = "Responsible for fetching the records from provided urls." )
30012973 creation_requester : Union [HttpRequester , CustomRequester ] = Field (
30022974 ...,
30032975 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