1
0
mirror of synced 2025-12-23 03:47:05 -05:00
Files
airbyte/docs/connector-development/config-based/understanding-the-yaml-file/reference.md
Joe Reuter e96fc22d6f Connector builder documentation: Auto-generate yaml reference and link up in fitting places (#25428)
* auto-generate yaml reference and link up

* Update description

* Add examples

* format

* update

* update

* add description for params

* Update declarative_component_schema.yaml

* render type and examples for interpolation variables

* fix schema bug

* Regenerate yarn lock file

---------

Co-authored-by: Alexandre Girard <alexandre@airbyte.io>
2023-04-26 16:08:35 +02:00

1.3 KiB

import ManifestYamlDefinitions from '@site/src/components/ManifestYamlDefinitions';

import schema from "../../../../airbyte-cdk/python/airbyte_cdk/sources/declarative/declarative_component_schema.yaml";

YAML Reference

This page lists all components, interpolation variables and interpolation macros that can be used when defining a low code YAML file.

For the technical JSON schema definition that low code manifests are validated against, see here.

export const toc = [ { "value": "Components:", "id": "components", "level": 2 }, { value: "DeclarativeSource", id: "/definitions/DeclarativeSource", level: 3 }, ...Object.keys(schema.definitions).map((id) => ({ value: id, id: /definitions/${id}, level: 3 })), { "value": "Interpolation variables:", "id": "variables", "level": 2 }, ...schema.interpolation.variables.map((def) => ({ value: def.title, id: /variables/${def.title}, level: 3 })), { "value": "Interpolation macros:", "id": "macros", "level": 2 }, ...schema.interpolation.macros.map((def) => ({ value: def.title, id: /macros/${def.title}, level: 3 })) ];