chore: Update description of execution_timeout in OpenLineage provide…

…r.yaml
apache · Mar 7, 2025 · 7bdbc37 · 7bdbc37
1 parent 43b1d63
commit 7bdbc37
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 11 deletions.
diff --git a/providers/openlineage/provider.yaml b/providers/openlineage/provider.yaml
@@ -66,8 +66,9 @@ config:
   openlineage:
     description: |
       This section applies settings for OpenLineage integration.
-      More about configuration and it's precedence can be found at
-      https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup
+      More about configuration and it's precedence can be found in the `user's guide
+      <https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup>`_.
+
     options:
       disabled:
         description: |
@@ -125,16 +126,18 @@ config:
         default: ""
       transport:
         description: |
-          Pass OpenLineage Client transport configuration as JSON string. It should contain type of the
-          transport and additional options (different for each transport type). For more details see:
-          https://openlineage.io/docs/client/python/#built-in-transport-types
+          Pass OpenLineage Client transport configuration as a JSON string, including the transport type
+          and any additional options specific to that type, as described in `OpenLineage docs
+          <https://openlineage.io/docs/client/python/#built-in-transport-types>`_.
 
           Currently supported types are:
 
             * HTTP
             * Kafka
             * Console
             * File
+            * Composite
+            * Custom
         type: string
         example: '{"type": "http", "url": "http://localhost:5000", "endpoint": "api/v1/lineage"}'
         default: ""
@@ -159,9 +162,10 @@ config:
       execution_timeout:
         description: |
           Maximum amount of time (in seconds) that OpenLineage can spend executing metadata extraction.
-          Note that other configurations, sometimes with higher priority, may also affect how much time
-          OpenLineage has for execution, such as core.task_success_overtime. For more details, see:
-          https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html#task-success-overtime
+          Note that other configurations, sometimes with higher priority, such as
+          `[core] task_success_overtime
+          <https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html#task-success-overtime>`_,
+          may also affect how much time OpenLineage has for execution.
         default: "10"
         example: ~
         type: integer

diff --git a/providers/openlineage/src/airflow/providers/openlineage/get_provider_info.py b/providers/openlineage/src/airflow/providers/openlineage/get_provider_info.py
@@ -72,7 +72,7 @@ def get_provider_info():
         ],
         "config": {
             "openlineage": {
-                "description": "This section applies settings for OpenLineage integration.\nMore about configuration and it's precedence can be found at\nhttps://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup\n",
+                "description": "This section applies settings for OpenLineage integration.\nMore about configuration and it's precedence can be found in the `user's guide\n<https://airflow.apache.org/docs/apache-airflow-providers-openlineage/stable/guides/user.html#transport-setup>`_.\n",
                 "options": {
                     "disabled": {
                         "description": "Disable sending events without uninstalling the OpenLineage Provider by setting this to true.\n",
@@ -124,7 +124,7 @@ def get_provider_info():
                         "default": "",
                     },
                     "transport": {
-                        "description": "Pass OpenLineage Client transport configuration as JSON string. It should contain type of the\ntransport and additional options (different for each transport type). For more details see:\nhttps://openlineage.io/docs/client/python/#built-in-transport-types\n\nCurrently supported types are:\n\n  * HTTP\n  * Kafka\n  * Console\n  * File\n",
+                        "description": "Pass OpenLineage Client transport configuration as a JSON string, including the transport type\nand any additional options specific to that type, as described in `OpenLineage docs\n<https://openlineage.io/docs/client/python/#built-in-transport-types>`_.\n\nCurrently supported types are:\n\n  * HTTP\n  * Kafka\n  * Console\n  * File\n  * Composite\n  * Custom\n",
                         "type": "string",
                         "example": '{"type": "http", "url": "http://localhost:5000", "endpoint": "api/v1/lineage"}',
                         "default": "",
@@ -145,7 +145,7 @@ def get_provider_info():
                         "version_added": "1.8.0",
                     },
                     "execution_timeout": {
-                        "description": "Maximum amount of time (in seconds) that OpenLineage can spend executing metadata extraction.\n",
+                        "description": "Maximum amount of time (in seconds) that OpenLineage can spend executing metadata extraction.\nNote that other configurations, sometimes with higher priority, such as\n`[core] task_success_overtime\n<https://airflow.apache.org/docs/apache-airflow/stable/configurations-ref.html#task-success-overtime>`_,\nmay also affect how much time OpenLineage has for execution.\n",
                         "default": "10",
                         "example": None,
                         "type": "integer",