Skip to content

Commit 56ab9b5

Browse files
authored
fix: improve stream template info in declarative_component_schema (#717)
1 parent 48c6836 commit 56ab9b5

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4142,11 +4142,9 @@ definitions:
41424142
- stream_slice
41434143
- stream_template_config
41444144
examples:
4145-
- ["data"]
4146-
- ["data", "records"]
4147-
- ["data", 1, "name"]
4148-
- ["data", "{{ components_values.name }}"]
4149-
- ["data", "*", "record"]
4145+
- ["name"]
4146+
- ["retriever", "requester", "url"]
4147+
- ["retriever", "requester", "{{ components_values.field }}"]
41504148
- ["*", "**", "name"]
41514149
value:
41524150
title: Value
@@ -4777,6 +4775,12 @@ interpolation:
47774775
- title: stream_slice
47784776
description: This variable is deprecated. Use stream_interval or stream_partition instead.
47794777
type: object
4778+
- title: components_values
4779+
description: The record object produced by the components resolver for which a stream will be generated.
4780+
type: object
4781+
examples:
4782+
- name: "accounts"
4783+
id: 1234
47804784
macros:
47814785
- title: now_utc
47824786
description: Returns the current date and time in the UTC timezone.

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1463,11 +1463,9 @@ class ComponentMappingDefinition(BaseModel):
14631463
...,
14641464
description="A list of potentially nested fields indicating the full path where value will be added or updated.",
14651465
examples=[
1466-
["data"],
1467-
["data", "records"],
1468-
["data", 1, "name"],
1469-
["data", "{{ components_values.name }}"],
1470-
["data", "*", "record"],
1466+
["name"],
1467+
["retriever", "requester", "url"],
1468+
["retriever", "requester", "{{ components_values.field }}"],
14711469
["*", "**", "name"],
14721470
],
14731471
title="Field Path",

0 commit comments

Comments
 (0)