@@ -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 (
@@ -1897,9 +1889,7 @@ class RecordSelector(BaseModel):
18971889 description = "Responsible for filtering records to be emitted by the Source." ,
18981890 title = "Record Filter" ,
18991891 )
1900- schema_normalization : Optional [
1901- Union [SchemaNormalization , CustomSchemaNormalization ]
1902- ] = Field (
1892+ schema_normalization : Optional [Union [SchemaNormalization , CustomSchemaNormalization ]] = Field (
19031893 None ,
19041894 description = "Responsible for normalization according to the schema." ,
19051895 title = "Schema Normalization" ,
@@ -2145,9 +2135,7 @@ class Config:
21452135 extra = Extra .allow
21462136
21472137 type : Literal ["DeclarativeStream" ]
2148- name : Optional [str ] = Field (
2149- "" , description = "The stream name." , example = ["Users" ], title = "Name"
2150- )
2138+ name : Optional [str ] = Field ("" , description = "The stream name." , example = ["Users" ], title = "Name" )
21512139 retriever : Union [SimpleRetriever , AsyncRetriever , CustomRetriever ] = Field (
21522140 ...,
21532141 description = "Component used to coordinate how records are extracted across stream slices and request pages." ,
@@ -2325,20 +2313,18 @@ class HttpRequester(BaseModelWithDeprecations):
23252313 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." ,
23262314 title = "Fetch Properties from Endpoint" ,
23272315 )
2328- request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = (
2329- Field (
2330- None ,
2331- description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2332- examples = [
2333- {"unit" : "day" },
2334- {
2335- "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2336- },
2337- {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2338- {"sort_by[asc]" : "updated_at" },
2339- ],
2340- title = "Query Parameters" ,
2341- )
2316+ request_parameters : Optional [Union [Dict [str , Union [str , QueryProperties ]], str ]] = Field (
2317+ None ,
2318+ description = "Specifies the query parameters that should be set on an outgoing HTTP request given the inputs." ,
2319+ examples = [
2320+ {"unit" : "day" },
2321+ {
2322+ "query" : 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2323+ },
2324+ {"searchIn" : "{{ ','.join(config.get('search_in', [])) }}" },
2325+ {"sort_by[asc]" : "updated_at" },
2326+ ],
2327+ title = "Query Parameters" ,
23422328 )
23432329 request_headers : Optional [Union [Dict [str , str ], str ]] = Field (
23442330 None ,
@@ -2528,9 +2514,7 @@ class QueryProperties(BaseModel):
25282514
25292515class StateDelegatingStream (BaseModel ):
25302516 type : Literal ["StateDelegatingStream" ]
2531- name : str = Field (
2532- ..., description = "The stream name." , example = ["Users" ], title = "Name"
2533- )
2517+ name : str = Field (..., description = "The stream name." , example = ["Users" ], title = "Name" )
25342518 full_refresh_stream : DeclarativeStream = Field (
25352519 ...,
25362520 description = "Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided." ,
@@ -2619,9 +2603,7 @@ class AsyncRetriever(BaseModel):
26192603 )
26202604 download_extractor : Optional [
26212605 Union [DpathExtractor , CustomRecordExtractor , ResponseToFileExtractor ]
2622- ] = Field (
2623- None , description = "Responsible for fetching the records from provided urls."
2624- )
2606+ ] = Field (None , description = "Responsible for fetching the records from provided urls." )
26252607 creation_requester : Union [HttpRequester , CustomRequester ] = Field (
26262608 ...,
26272609 description = "Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job." ,
@@ -2761,12 +2743,10 @@ class DynamicDeclarativeStream(BaseModel):
27612743 stream_template : DeclarativeStream = Field (
27622744 ..., description = "Reference to the stream template." , title = "Stream Template"
27632745 )
2764- components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = (
2765- Field (
2766- ...,
2767- description = "Component resolve and populates stream templates with components values." ,
2768- title = "Components Resolver" ,
2769- )
2746+ components_resolver : Union [HttpComponentsResolver , ConfigComponentsResolver ] = Field (
2747+ ...,
2748+ description = "Component resolve and populates stream templates with components values." ,
2749+ title = "Components Resolver" ,
27702750 )
27712751
27722752
0 commit comments