AmarEL opened a new issue #8900:
URL: https://github.com/apache/airflow/issues/8900
<!--
Welcome to Apache Airflow! For a smooth issue process, try to answer the
following questions.
Don't worry if they're not all applicable; just try to include what you can
:-)
If you need to include code snippets or logs, please put them in fenced code
blocks. If they're super-long, please use the details tag like
<details><summary>super-long log</summary> lots of stuff </details>
Please delete these comment blocks before submitting the issue.
-->
**Description**
The information and examples about the optional JSON `conf` when triggering
a dag from UI or by CLI needs to be included in the documentation.
**Use case / motivation**
I would like to have some reference in Docs since `conf` is not even
mentioned as a parameter in the` create_dagrun` method in the specification of
parameters. I would like to have too some examples of how to use `conf` in a
DAG definition code since there is no section for that yet and some people,
like me, would be missing this information about how to access this parameter.
```
@provide_session
def create_dagrun(self,
run_id,
state,
execution_date=None,
start_date=None,
external_trigger=False,
conf=None,
session=None):
"""
Creates a dag run from this dag including the tasks associated with
this dag.
Returns the dag run.
:param run_id: defines the run id for this dag run
:type run_id: str
:param execution_date: the execution date of this dag run
:type execution_date: datetime.datetime
:param state: the state of the dag run
:type state: airflow.utils.state.State
:param start_date: the date this dag run should be evaluated
:type start_date: datetime
:param external_trigger: whether this dag run is externally triggered
:type external_trigger: bool
:param session: database session
:type session: sqlalchemy.orm.session.Session
"""
```
**Related Issues**
https://github.com/apache/airflow/pull/7312
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
