You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "uranusjr (via GitHub)" <gi...@apache.org> on 2026/06/24 01:33:58 UTC
[PR] Add news fragment and documentation for the result decorator [airflow]
uranusjr opened a new pull request, #68928:
URL: https://github.com/apache/airflow/pull/68928
See #64563 for the implementation.
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add news fragment and documentation for the result decorator [airflow]
Posted by "vatsrahul1001 (via GitHub)" <gi...@apache.org>.
vatsrahul1001 merged PR #68928:
URL: https://github.com/apache/airflow/pull/68928
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add news fragment and documentation for the result decorator [airflow]
Posted by "phanikumv (via GitHub)" <gi...@apache.org>.
phanikumv commented on code in PR #68928:
URL: https://github.com/apache/airflow/pull/68928#discussion_r3464678621
##########
airflow-core/docs/authoring-and-scheduling/dag-result.rst:
##########
@@ -0,0 +1,140 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _dag-result:
+
+==========
+DAG Result
+==========
+
+|experimental|
+
+.. versionadded:: 3.3
+
+Airflow supports designating one or more tasks as *result tasks* for a DAG. When a DAG has a result task, its return value is surfaced by the ``/dags/{dag_id}/dagRuns/{dag_run_id}/wait`` API, making it straightforward to embed Airflow DAGs in API endpoints, chat agents, or inference services that need a response value without polling or custom glue code.
+
+
+Marking the result task
+=======================
+
+There are three equivalent ways to designate a result task.
Review Comment:
since only two ways have been documented here
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add news fragment and documentation for the result decorator [airflow]
Posted by "phanikumv (via GitHub)" <gi...@apache.org>.
phanikumv commented on code in PR #68928:
URL: https://github.com/apache/airflow/pull/68928#discussion_r3464683332
##########
airflow-core/newsfragments/64563.feature.rst:
##########
@@ -0,0 +1 @@
+Add ``@result`` decorator to mark a TaskFlow task as the DAG's result task. When ``@dag`` is used, returning a task's ``XComArg`` from the decorated function also designates it as the result automatically. The result task's return value is included in the ``/dags/{dag_id}/dagRuns/{dag_run_id}/wait`` API response by default when the ``result`` query parameter is not explicitly set.
Review Comment:
we should add a `skip newsfragment check` label to this PR if we want to point at `64563.feature.rst`
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add news fragment and documentation for the result decorator [airflow]
Posted by "phanikumv (via GitHub)" <gi...@apache.org>.
phanikumv commented on code in PR #68928:
URL: https://github.com/apache/airflow/pull/68928#discussion_r3464677558
##########
airflow-core/docs/authoring-and-scheduling/dag-result.rst:
##########
@@ -0,0 +1,140 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ .. http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. _dag-result:
+
+==========
+DAG Result
+==========
+
+|experimental|
+
+.. versionadded:: 3.3
+
+Airflow supports designating one or more tasks as *result tasks* for a DAG. When a DAG has a result task, its return value is surfaced by the ``/dags/{dag_id}/dagRuns/{dag_run_id}/wait`` API, making it straightforward to embed Airflow DAGs in API endpoints, chat agents, or inference services that need a response value without polling or custom glue code.
+
+
+Marking the result task
+=======================
+
+There are three equivalent ways to designate a result task.
Review Comment:
```suggestion
There are two equivalent ways to designate a result task.
```
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] Add news fragment and documentation for the result decorator [airflow]
Posted by "vatsrahul1001 (via GitHub)" <gi...@apache.org>.
vatsrahul1001 commented on code in PR #68928:
URL: https://github.com/apache/airflow/pull/68928#discussion_r3464691051
##########
airflow-core/newsfragments/64563.feature.rst:
##########
@@ -0,0 +1 @@
+Add ``@result`` decorator to mark a TaskFlow task as the DAG's result task. When ``@dag`` is used, returning a task's ``XComArg`` from the decorated function also designates it as the result automatically. The result task's return value is included in the ``/dags/{dag_id}/dagRuns/{dag_run_id}/wait`` API response by default when the ``result`` query parameter is not explicitly set.
Review Comment:
Added label
--
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.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org