Skip to content

Commit c452c67

Browse files
author
octavia-squidington-iii
committed
Auto-fix lint and format issues
1 parent 49f4900 commit c452c67

File tree

1 file changed

+42
-62
lines changed

1 file changed

+42
-62
lines changed

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

Lines changed: 42 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -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.\nMust be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification\nusing special annotation 'path_in_connector_config'.\nThese are input values the user is entering through the UI to authenticate to the connector, that might also shared\nas inputs for syncing data via the connector.\nExamples:\nif no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[]\nif 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 }\nif 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.\nMust be a valid non-nested JSON that refers to properties from ConnectorSpecification.connectionSpecification\nusing special annotation 'path_in_connector_config'.\nThese are input values the user is entering through the UI to authenticate to the connector, that might also shared\nas inputs for syncing data via the connector.\nExamples:\nif no connector values is shared during oauth flow, oauth_user_input_from_connector_config_specification=[]\nif 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 }\nif 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.\nPertains to the fields defined by the connector relating to the OAuth flow.\n\nInterpolation 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\nExamples:\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.\nPertains to the fields defined by the connector relating to the OAuth flow.\n\nInterpolation 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\nExamples:\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.\nMust be a valid non-nested JSON describing additional fields configured by the Airbyte Instance or Workspace Admins to be used by the\nserver when completing an OAuth flow (typically exchanging an auth code for refresh token).\nExamples:\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(
@@ -1852,9 +1844,9 @@ class DefaultPaginator(BaseModel):
18521844

18531845
class CombinedExtractor(BaseModel):
18541846
type: Literal["CombinedExtractor"]
1855-
extractors: List[
1856-
Union[DpathExtractor, CombinedExtractor, CustomRecordExtractor]
1857-
] = Field(..., description="placeholder")
1847+
extractors: List[Union[DpathExtractor, CombinedExtractor, CustomRecordExtractor]] = Field(
1848+
..., description="placeholder"
1849+
)
18581850
parameters: Optional[Dict[str, Any]] = Field(None, alias="$parameters")
18591851

18601852

@@ -1901,9 +1893,7 @@ class RecordSelector(BaseModel):
19011893
description="Responsible for filtering records to be emitted by the Source.",
19021894
title="Record Filter",
19031895
)
1904-
schema_normalization: Optional[
1905-
Union[SchemaNormalization, CustomSchemaNormalization]
1906-
] = Field(
1896+
schema_normalization: Optional[Union[SchemaNormalization, CustomSchemaNormalization]] = Field(
19071897
None,
19081898
description="Responsible for normalization according to the schema.",
19091899
title="Schema Normalization",
@@ -2149,9 +2139,7 @@ class Config:
21492139
extra = Extra.allow
21502140

21512141
type: Literal["DeclarativeStream"]
2152-
name: Optional[str] = Field(
2153-
"", description="The stream name.", example=["Users"], title="Name"
2154-
)
2142+
name: Optional[str] = Field("", description="The stream name.", example=["Users"], title="Name")
21552143
retriever: Union[SimpleRetriever, AsyncRetriever, CustomRetriever] = Field(
21562144
...,
21572145
description="Component used to coordinate how records are extracted across stream slices and request pages.",
@@ -2329,20 +2317,18 @@ class HttpRequester(BaseModelWithDeprecations):
23292317
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.",
23302318
title="Fetch Properties from Endpoint",
23312319
)
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-
)
2320+
request_parameters: Optional[Union[Dict[str, Union[str, QueryProperties]], str]] = Field(
2321+
None,
2322+
description="Specifies the query parameters that should be set on an outgoing HTTP request given the inputs.",
2323+
examples=[
2324+
{"unit": "day"},
2325+
{
2326+
"query": 'last_event_time BETWEEN TIMESTAMP "{{ stream_interval.start_time }}" AND TIMESTAMP "{{ stream_interval.end_time }}"'
2327+
},
2328+
{"searchIn": "{{ ','.join(config.get('search_in', [])) }}"},
2329+
{"sort_by[asc]": "updated_at"},
2330+
],
2331+
title="Query Parameters",
23462332
)
23472333
request_headers: Optional[Union[Dict[str, str], str]] = Field(
23482334
None,
@@ -2532,9 +2518,7 @@ class QueryProperties(BaseModel):
25322518

25332519
class StateDelegatingStream(BaseModel):
25342520
type: Literal["StateDelegatingStream"]
2535-
name: str = Field(
2536-
..., description="The stream name.", example=["Users"], title="Name"
2537-
)
2521+
name: str = Field(..., description="The stream name.", example=["Users"], title="Name")
25382522
full_refresh_stream: DeclarativeStream = Field(
25392523
...,
25402524
description="Component used to coordinate how records are extracted across stream slices and request pages when the state is empty or not provided.",
@@ -2623,9 +2607,7 @@ class AsyncRetriever(BaseModel):
26232607
)
26242608
download_extractor: Optional[
26252609
Union[DpathExtractor, CustomRecordExtractor, ResponseToFileExtractor]
2626-
] = Field(
2627-
None, description="Responsible for fetching the records from provided urls."
2628-
)
2610+
] = Field(None, description="Responsible for fetching the records from provided urls.")
26292611
creation_requester: Union[HttpRequester, CustomRequester] = Field(
26302612
...,
26312613
description="Requester component that describes how to prepare HTTP requests to send to the source API to create the async server-side job.",
@@ -2765,12 +2747,10 @@ class DynamicDeclarativeStream(BaseModel):
27652747
stream_template: DeclarativeStream = Field(
27662748
..., description="Reference to the stream template.", title="Stream Template"
27672749
)
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-
)
2750+
components_resolver: Union[HttpComponentsResolver, ConfigComponentsResolver] = Field(
2751+
...,
2752+
description="Component resolve and populates stream templates with components values.",
2753+
title="Components Resolver",
27742754
)
27752755

27762756

0 commit comments

Comments
 (0)