Skip to content

Commit c32b668

Browse files
authored
Add HITL operators to standard provider index docs (#60681)
1 parent 4f0b7e9 commit c32b668

File tree

3 files changed

+55
-0
lines changed

3 files changed

+55
-0
lines changed

airflow-core/docs/tutorial/hitl.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,3 +190,12 @@ Benefits and Common Use Cases
190190

191191
HITL functionality is valuable in large language model (LLM) workflows, where human-provided guidance can be essential for achieving better results.
192192
It is also highly beneficial in enterprise data pipelines, where human validation can complement and enhance automated processes.
193+
194+
See also
195+
--------
196+
197+
* `Standard provider HITL operators documentation
198+
<https://airflow.apache.org/docs/apache-airflow-providers-standard/stable/operators/hitl.html>`_
199+
200+
* `HITL operators Python API reference
201+
<https://airflow.apache.org/docs/apache-airflow-providers-standard/stable/_api/airflow/providers/standard/operators/hitl/index.html>`_

docs/spelling_wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -831,6 +831,8 @@ healthjump
831831
heartrate
832832
heatmap
833833
Highcharts
834+
HITL
835+
hitl
834836
hivecmd
835837
hiveconf
836838
hiveconfs
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
or more contributor license agreements. See the NOTICE file
3+
distributed with this work for additional information
4+
regarding copyright ownership. The ASF licenses this file
5+
to you under the Apache License, Version 2.0 (the
6+
"License"); you may not use this file except in compliance
7+
with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
software distributed under the License is distributed on an
13+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations
16+
under the License.
17+
18+
Human in the Loop (HITL) Operators
19+
==================================
20+
21+
Human-in-the-Loop (HITL) operators enable workflows where task execution
22+
can pause and wait for human input, approval, or intervention before
23+
continuing.
24+
25+
These operators are part of the ``apache-airflow-providers-standard``
26+
package and are intended for modeling approval steps or manual decision
27+
points within automated pipelines.
28+
29+
Available HITL operators
30+
------------------------
31+
32+
The Standard provider includes Human-in-the-Loop (HITL) operators.
33+
For the complete and up-to-date list of available operators and their
34+
parameters, refer to the Python API documentation:
35+
36+
`Python API reference <https://airflow.apache.org/docs/apache-airflow-providers-standard/stable/_api/airflow/providers/standard/operators/hitl/index.html>`_
37+
38+
Usage guide
39+
-----------
40+
41+
For an end-to-end guide on using HITL operators, including examples and
42+
recommended patterns, see the HITL tutorial:
43+
44+
* `HITL tutorial <https://airflow.apache.org/docs/apache-airflow/stable/tutorial/hitl.html>`_

0 commit comments

Comments
 (0)