diff --git a/docs/usage/configs.md b/docs/usage/configs.md index e48df84..bd5c23f 100644 --- a/docs/usage/configs.md +++ b/docs/usage/configs.md @@ -12,6 +12,9 @@ Configs are defined in YAML files. The core structure consists of a two elements source in `sources`. ```yaml +name: config_name +metadata: + version: '0.0.0' sources: source-alias: writer: bq @@ -27,6 +30,8 @@ global_parameters: where: +* **name**: Optional config name. +* **metadata**: Optional metadata on config (version, description). * **source-alias**: The source of data. Check [available fetchers](../fetchers/overview.md). * **fetcher_parameters**: Key value pairs used to fine-tune fetching process. * **writer**: Where the data should be saved. Check [available writers](writers.md). diff --git a/docs/usage/workflows.md b/docs/usage/workflows.md index bc94353..5c42830 100644 --- a/docs/usage/workflows.md +++ b/docs/usage/workflows.md @@ -13,9 +13,16 @@ where each step interacts with a specific data source (fetcher) and writes to a Workflows are defined in YAML files. The core structure consists of a list of `steps`, where each step defines what data to fetch and where to save it. -### Workflow Step Structure +### Workflow Structure ```yaml +name: test_workflow +metadata: + description: Test workflow description + version: '0.0.0' + required_garf_version: "" + required_fetchers: + garf-google-ads: "1.0.0" steps: - alias: step_name fetcher: source_name @@ -40,6 +47,12 @@ steps: ### Components +* **name**: Optional name of the workflow +* **metadata**: Optional metadata for the workflow. + * **description**: Short description of the workflow. + * **version**: Version of the workflow. + * **required_garf_version**: Minimal required version of garf-executors library. + * **required_fetchers**: Required fetchers and their version. * **fetcher**: The source of data. Check [available fetchers](../fetchers/overview.md). * **fetcher_parameters**: Key value pairs used to fine-tune fetching process. * **alias**: A unique identifier for the step. Useful for logging and [selective execution](#selective-execution). diff --git a/libs/executors/garf/executors/__init__.py b/libs/executors/garf/executors/__init__.py index 30dba45..350e7b1 100644 --- a/libs/executors/garf/executors/__init__.py +++ b/libs/executors/garf/executors/__init__.py @@ -21,4 +21,4 @@ 'ApiQueryExecutor', ] -__version__ = '1.4.2' +__version__ = '1.4.3'