Skip to content

Commit

Permalink
Provide more context for trigger_reason in DbtCloudRunJobOperator (#…
Browse files Browse the repository at this point in the history
…28994)

Users may be confused when comparing the dbt API and the Python API docs for the DbtCloudRunJobOperator re: to `trigger_reason`. This value is required for the dbt API but not for the operator. The operator will handle providing a default value. Adding the default value in the `trigger_reason` param docstring so users have additional context when reading the Python API doc for the operator.
  • Loading branch information
josh-fell authored Jan 17, 2023
1 parent c568874 commit 4f91931
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions airflow/providers/dbt/cloud/operators/dbt.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ class DbtCloudRunJobOperator(BaseOperator):
:param job_id: The ID of a dbt Cloud job.
:param account_id: Optional. The ID of a dbt Cloud account.
:param trigger_reason: Optional. Description of the reason to trigger the job.
Defaults to "Triggered via Apache Airflow by task <task_id> in the <dag_id> DAG."
:param steps_override: Optional. List of dbt commands to execute when triggering the job instead of those
configured in dbt Cloud.
:param schema_override: Optional. Override the destination schema in the configured target for this job.
Expand Down

0 comments on commit 4f91931

Please sign in to comment.