Skip to content

Commit a7054e5

Browse files
committed
update titles and descriptions of boolean fields in Incremental Sync
1 parent 6a2e3b8 commit a7054e5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1081,21 +1081,21 @@ definitions:
10811081
examples:
10821082
- "PT1S"
10831083
is_data_feed:
1084-
title: Whether the target API is formatted as a data feed
1084+
title: Data Feed API
10851085
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.
10861086
type: boolean
10871087
is_client_side_incremental:
1088-
title: Whether the target API does not support filtering and returns all data (the cursor filters records in the client instead of the API side)
1089-
description: If the target API endpoint does not take cursor values to filter records and returns all records anyway, the connector with this cursor will filter out records locally, and only emit new records from the last sync, hence incremental. This means that all records would be read from the API, but only new records will be emitted to the destination.
1088+
title: Client-side Incremental Filtering
1089+
description: Set to True if the target API endpoint does not take cursor values to filter records and returns all records anyway. This will cause the connector to filter out records locally, and only emit new records from the last sync, hence incremental. This means that all records would be read from the API, but only new records will be emitted to the destination.
10901090
type: boolean
10911091
is_compare_strictly:
1092-
title: Whether to skip requests if the start time equals the end time
1093-
description: Set to True if the target API does not accept queries where the start time equal the end time.
1092+
title: Strict Start-End Time Comparison
1093+
description: Set to True if the target API does not accept queries where the start time equal the end time. This will cause those requests to be skipped.
10941094
type: boolean
10951095
default: False
10961096
global_substream_cursor:
1097-
title: Whether to store cursor as one value instead of per partition
1098-
description: This setting optimizes performance when the parent stream has thousands of partitions by storing the cursor as a single value rather than per partition. Notably, the substream state is updated only at the end of the sync, which helps prevent data loss in case of a sync failure. See more info in the [docs](https://docs.airbyte.com/connector-development/config-based/understanding-the-yaml-file/incremental-syncs).
1097+
title: Global Substream Cursor
1098+
description: Setting to True causes the connector to store the cursor as one value, instead of per-partition. This setting optimizes performance when the parent stream has thousands of partitions. Notably, the substream state is updated only at the end of the sync, which helps prevent data loss in case of a sync failure. See more info in the [docs](https://docs.airbyte.com/connector-development/config-based/understanding-the-yaml-file/incremental-syncs).
10991099
type: boolean
11001100
default: false
11011101
lookback_window:

0 commit comments

Comments
 (0)