1
0
mirror of synced 2025-12-23 11:57:55 -05:00
Files
airbyte/docs/connector-development/config-based/advanced-topics/parameters.md
2025-02-04 12:20:31 -08:00

977 B

Parameters

Parameters can be passed down from a parent component to its subcomponents using the $parameters key. This can be used to avoid repetitions.

Schema:

"$parameters":
  type: object
  additionalProperties: true

Example:

outer:
  $parameters:
    MyKey: MyValue
  inner:
    k2: v2

This the example above, if both outer and inner are types with a "MyKey" field, both of them will evaluate to "MyValue".

These parameters can be overwritten by subcomponents as a form of specialization:

outer:
  $parameters:
    MyKey: MyValue
  inner:
    $parameters:
      MyKey: YourValue
    k2: v2

In this example, "outer.MyKey" will evaluate to "MyValue", and "inner.MyKey" will evaluate to "YourValue".

The value can also be used for string interpolation:

outer:
  $parameters:
    MyKey: MyValue
  inner:
    k2: "MyKey is {{ parameters['MyKey'] }}"

In this example, outer.inner.k2 will evaluate to "MyKey is MyValue"