Skip to content

Commit e44362a

Browse files
lmossmanlmossman
authored
chore: more reordering and title description updates in declarative_component_schema (#570)
1 parent 8e4d946 commit e44362a

File tree

1 file changed

+60
-53
lines changed

1 file changed

+60
-53
lines changed

‎airbyte_cdk/sources/declarative/declarative_component_schema.yaml

Lines changed: 60 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -296,12 +296,12 @@ definitions:
296296
- "$ref": "#/definitions/ApiKeyAuthenticator"
297297
- "$ref": "#/definitions/BasicHttpAuthenticator"
298298
- "$ref": "#/definitions/BearerAuthenticator"
299-
- "$ref": "#/definitions/CustomAuthenticator"
300299
- "$ref": "#/definitions/OAuthAuthenticator"
301300
- "$ref": "#/definitions/JwtAuthenticator"
302301
- "$ref": "#/definitions/SessionTokenAuthenticator"
303-
- "$ref": "#/definitions/NoAuth"
304302
- "$ref": "#/definitions/LegacySessionTokenAuthenticator"
303+
- "$ref": "#/definitions/CustomAuthenticator"
304+
- "$ref": "#/definitions/NoAuth"
305305
examples:
306306
- authenticators:
307307
token: "#/definitions/ApiKeyAuthenticator"
@@ -907,6 +907,49 @@ definitions:
907907
examples:
908908
- "created_at"
909909
- "{{ config['record_cursor'] }}"
910+
cursor_datetime_formats:
911+
title: Cursor Datetime Formats
912+
description: The possible formats for the cursor field, in order of preference. The first format that matches the cursor field value will be used to parse it. If not provided, the `datetime_format` will be used.
913+
type: array
914+
items:
915+
type: string
916+
examples:
917+
- "%Y-%m-%dT%H:%M:%S.%f%z"
918+
- "%Y-%m-%d"
919+
- "%s"
920+
start_datetime:
921+
title: Start Datetime
922+
description: The datetime that determines the earliest record that should be synced.
923+
anyOf:
924+
- "$ref": "#/definitions/MinMaxDatetime"
925+
- type: string
926+
title: Interpolated Value
927+
interpolation_context:
928+
- config
929+
examples:
930+
- "2020-01-1T00:00:00Z"
931+
- "{{ config['start_time'] }}"
932+
start_time_option:
933+
title: Inject Start Time Into Outgoing HTTP Request
934+
description: Optionally configures how the start datetime will be sent in requests to the source API.
935+
"$ref": "#/definitions/RequestOption"
936+
end_datetime:
937+
title: End Datetime
938+
description: The datetime that determines the last record that should be synced. If not provided, `{{ now_utc() }}` will be used.
939+
anyOf:
940+
- "$ref": "#/definitions/MinMaxDatetime"
941+
- type: string
942+
title: Interpolated Value
943+
interpolation_context:
944+
- config
945+
examples:
946+
- "2021-01-1T00:00:00Z"
947+
- "{{ now_utc() }}"
948+
- "{{ day_delta(-1) }}"
949+
end_time_option:
950+
title: Inject End Time Into Outgoing HTTP Request
951+
description: Optionally configures how the end datetime will be sent in requests to the source API.
952+
"$ref": "#/definitions/RequestOption"
910953
datetime_format:
911954
title: Outgoing Datetime Format
912955
description: |
@@ -948,27 +991,6 @@ definitions:
948991
- "%s"
949992
- "%ms"
950993
- "%s_as_float"
951-
start_datetime:
952-
title: Start Datetime
953-
description: The datetime that determines the earliest record that should be synced.
954-
anyOf:
955-
- type: string
956-
- "$ref": "#/definitions/MinMaxDatetime"
957-
interpolation_context:
958-
- config
959-
examples:
960-
- "2020-01-1T00:00:00Z"
961-
- "{{ config['start_time'] }}"
962-
cursor_datetime_formats:
963-
title: Cursor Datetime Formats
964-
description: The possible formats for the cursor field, in order of preference. The first format that matches the cursor field value will be used to parse it. If not provided, the `datetime_format` will be used.
965-
type: array
966-
items:
967-
type: string
968-
examples:
969-
- "%Y-%m-%dT%H:%M:%S.%f%z"
970-
- "%Y-%m-%d"
971-
- "%s"
972994
cursor_granularity:
973995
title: Cursor Granularity
974996
description:
@@ -977,22 +999,6 @@ definitions:
977999
type: string
9781000
examples:
9791001
- "PT1S"
980-
end_datetime:
981-
title: End Datetime
982-
description: The datetime that determines the last record that should be synced. If not provided, `{{ now_utc() }}` will be used.
983-
anyOf:
984-
- type: string
985-
- "$ref": "#/definitions/MinMaxDatetime"
986-
interpolation_context:
987-
- config
988-
examples:
989-
- "2021-01-1T00:00:00Z"
990-
- "{{ now_utc() }}"
991-
- "{{ day_delta(-1) }}"
992-
end_time_option:
993-
title: Inject End Time Into Outgoing HTTP Request
994-
description: Optionally configures how the end datetime will be sent in requests to the source API.
995-
"$ref": "#/definitions/RequestOption"
9961002
is_data_feed:
9971003
title: Whether the target API is formatted as a data feed
9981004
description: A data feed API is an API that does not allow filtering and paginates the content from the most recent to the least recent. Given this, the CDK needs to know when to stop paginating and this field will generate a stop condition for pagination.
@@ -1032,10 +1038,6 @@ definitions:
10321038
type: string
10331039
examples:
10341040
- "starting_time"
1035-
start_time_option:
1036-
title: Inject Start Time Into Outgoing HTTP Request
1037-
description: Optionally configures how the start datetime will be sent in requests to the source API.
1038-
"$ref": "#/definitions/RequestOption"
10391041
step:
10401042
title: Step
10411043
description: The size of the time window (ISO8601 duration). Given this field is provided, `cursor_granularity` needs to be provided as well.
@@ -1429,14 +1431,15 @@ definitions:
14291431
- "$ref": "#/definitions/InlineSchemaLoader"
14301432
- "$ref": "#/definitions/DynamicSchemaLoader"
14311433
- "$ref": "#/definitions/JsonFileSchemaLoader"
1432-
- "$ref": "#/definitions/CustomSchemaLoader"
1433-
- type: array
1434+
- title: Multiple Schema Loaders
1435+
type: array
14341436
items:
14351437
anyOf:
14361438
- "$ref": "#/definitions/InlineSchemaLoader"
14371439
- "$ref": "#/definitions/DynamicSchemaLoader"
14381440
- "$ref": "#/definitions/JsonFileSchemaLoader"
14391441
- "$ref": "#/definitions/CustomSchemaLoader"
1442+
- "$ref": "#/definitions/CustomSchemaLoader"
14401443
# TODO we have move the transformation to the RecordSelector level in the code but kept this here for
14411444
# compatibility reason. We should eventually move this to align with the code.
14421445
transformations:
@@ -1446,13 +1449,13 @@ definitions:
14461449
items:
14471450
anyOf:
14481451
- "$ref": "#/definitions/AddFields"
1449-
- "$ref": "#/definitions/CustomTransformation"
14501452
- "$ref": "#/definitions/RemoveFields"
14511453
- "$ref": "#/definitions/KeysToLower"
14521454
- "$ref": "#/definitions/KeysToSnakeCase"
14531455
- "$ref": "#/definitions/FlattenFields"
14541456
- "$ref": "#/definitions/DpathFlattenFields"
14551457
- "$ref": "#/definitions/KeysReplace"
1458+
- "$ref": "#/definitions/CustomTransformation"
14561459
state_migrations:
14571460
title: State Migrations
14581461
description: Array of state migrations to be applied on the input state
@@ -1689,10 +1692,10 @@ definitions:
16891692
items:
16901693
anyOf:
16911694
- "$ref": "#/definitions/ConstantBackoffStrategy"
1692-
- "$ref": "#/definitions/CustomBackoffStrategy"
16931695
- "$ref": "#/definitions/ExponentialBackoffStrategy"
16941696
- "$ref": "#/definitions/WaitTimeFromHeader"
16951697
- "$ref": "#/definitions/WaitUntilTimeFromHeader"
1698+
- "$ref": "#/definitions/CustomBackoffStrategy"
16961699
max_retries:
16971700
title: Max Retry Count
16981701
description: The maximum number of time to retry a retryable request before giving up and failing.
@@ -2315,9 +2318,9 @@ definitions:
23152318
title: Retriever
23162319
description: Component used to coordinate how records are extracted across stream slices and request pages.
23172320
anyOf:
2321+
- "$ref": "#/definitions/SimpleRetriever"
23182322
- "$ref": "#/definitions/AsyncRetriever"
23192323
- "$ref": "#/definitions/CustomRetriever"
2320-
- "$ref": "#/definitions/SimpleRetriever"
23212324
schema_filter:
23222325
title: Schema Filter
23232326
description: Responsible for filtering fields to be added to json schema.
@@ -2331,13 +2334,13 @@ definitions:
23312334
items:
23322335
anyOf:
23332336
- "$ref": "#/definitions/AddFields"
2334-
- "$ref": "#/definitions/CustomTransformation"
23352337
- "$ref": "#/definitions/RemoveFields"
23362338
- "$ref": "#/definitions/KeysToLower"
23372339
- "$ref": "#/definitions/KeysToSnakeCase"
23382340
- "$ref": "#/definitions/FlattenFields"
23392341
- "$ref": "#/definitions/DpathFlattenFields"
23402342
- "$ref": "#/definitions/KeysReplace"
2343+
- "$ref": "#/definitions/CustomTransformation"
23412344
schema_type_identifier:
23422345
"$ref": "#/definitions/SchemaTypeIdentifier"
23432346
$parameters:
@@ -2359,6 +2362,8 @@ definitions:
23592362
type: object
23602363
additionalProperties: true
23612364
JsonFileSchemaLoader:
2365+
deprecated: true
2366+
deprecation_message: "Use `InlineSchemaLoader` instead."
23622367
title: Json File Schema Loader
23632368
description: Loads the schema from a json file.
23642369
type: object
@@ -3761,7 +3766,7 @@ definitions:
37613766
- "$ref": "#/definitions/GroupingPartitionRouter"
37623767
- "$ref": "#/definitions/CustomPartitionRouter"
37633768
decoder:
3764-
title: Decoder
3769+
title: HTTP Response Format
37653770
description: Component decoding the response so records can be extracted.
37663771
anyOf:
37673772
- "$ref": "#/definitions/CsvDecoder"
@@ -3773,7 +3778,7 @@ definitions:
37733778
- "$ref": "#/definitions/ZipfileDecoder"
37743779
- "$ref": "#/definitions/CustomDecoder"
37753780
download_decoder:
3776-
title: Download Decoder
3781+
title: Download HTTP Response Format
37773782
description: Component decoding the download response so records can be extracted.
37783783
anyOf:
37793784
- "$ref": "#/definitions/CsvDecoder"
@@ -3958,9 +3963,9 @@ definitions:
39583963
title: Underlying Partition Router
39593964
description: The partition router whose output will be grouped. This can be any valid partition router component.
39603965
anyOf:
3961-
- "$ref": "#/definitions/CustomPartitionRouter"
39623966
- "$ref": "#/definitions/ListPartitionRouter"
39633967
- "$ref": "#/definitions/SubstreamPartitionRouter"
3968+
- "$ref": "#/definitions/CustomPartitionRouter"
39643969
deduplicate:
39653970
title: Deduplicate Partitions
39663971
description: If true, ensures that partitions are unique within each group by removing duplicates based on the partition key.
@@ -4069,6 +4074,7 @@ definitions:
40694074
additionalProperties: true
40704075
HttpComponentsResolver:
40714076
type: object
4077+
title: Http Components Resolver
40724078
description: (This component is experimental. Use at your own risk.) Component resolve and populates stream templates with components fetched via an HTTP retriever.
40734079
properties:
40744080
type:
@@ -4078,9 +4084,9 @@ definitions:
40784084
title: Retriever
40794085
description: Component used to coordinate how records are extracted across stream slices and request pages.
40804086
anyOf:
4087+
- "$ref": "#/definitions/SimpleRetriever"
40814088
- "$ref": "#/definitions/AsyncRetriever"
40824089
- "$ref": "#/definitions/CustomRetriever"
4083-
- "$ref": "#/definitions/SimpleRetriever"
40844090
components_mapping:
40854091
type: array
40864092
items:
@@ -4126,6 +4132,7 @@ definitions:
41264132
additionalProperties: true
41274133
ConfigComponentsResolver:
41284134
type: object
4135+
title: Config Components Resolver
41294136
description: (This component is experimental. Use at your own risk.) Resolves and populates stream templates with components fetched from the source config.
41304137
properties:
41314138
type:

0 commit comments

Comments
 (0)