fix(hitl): make the user model in HITLDetail consistent with airflow user model #55463

Lee-W · 2025-09-10T15:09:57Z

Why

To enhance clarity and consistency in the Human-In-The-Loop (HITL) feature by standardizing the naming conventions and user-related interfaces. The term "respondents" has been ambiguous, and the user interface used (respondents, responded_user_id, and responded_user_name) is inconsistent, which can lead to confusion.

What

Database
- Rename respondants to assignees and change the data format from list[str] to list[dict[str, str]].
- Merge responded_by_user_id and responded_by_user_name into a single field named responded_by, formatted as a dict[str, str] JSON field.
User Interface
- Replace respondants with assigned_users, using the type dict[str, str] (TypedDict HITLUser with the structure {"id":..., "name":...}) (saved as assignees in DB)
- Merge responded_by_user_id and responded_by_user_name into responded_by_user, formatted as a dict[str, str]. (saved as responded_by in db). This information is also included in the TriggerEvent returned by the HTILTrigger which can be used by the user now.

The main reason for separating the DB name and the user interface name is for typing.

^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in airflow-core/newsfragments.

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_hitl.py

airflow-core/tests/unit/api_fastapi/execution_api/versions/head/test_hitl.py

airflow-core/src/airflow/models/hitl.py

sjyangkevin

some small questions and comments. hope these could help

Lee-W · 2025-09-11T14:21:29Z

some small questions and comments. hope these could help

Thanks for helping out :)

…user model (#55463) (cherry picked from commit 30c193b)

…user model (apache#55463)

(from https://github.com/apache/airflow/tree/python-client/3.1.0rc1) ## New Features: - Add `map_index` filter to TaskInstance API queries ([#55614](apache/airflow#55614)) - Add `has_import_errors` filter to Core API GET /dags endpoint ([#54563](apache/airflow#54563)) - Add `dag_version` filter to get_dag_runs endpoint ([#54882](apache/airflow#54882)) - Implement pattern search for event log endpoint ([#55114](apache/airflow#55114)) - Add asset-based filtering support to DAG API endpoint ([#54263](apache/airflow#54263)) - Add Greater Than and Less Than range filters to DagRuns and Task Instance list ([#54302](apache/airflow#54302)) - Add `try_number` as filter to task instances ([#54695](apache/airflow#54695)) - Add filters to Browse XComs endpoint ([#54049](apache/airflow#54049)) - Add Filtering by DAG Bundle Name and Version to API routes ([#54004](apache/airflow#54004)) - Add search filter for DAG runs by triggering user name ([#53652](apache/airflow#53652)) - Enable multi sorting (AIP-84) ([#53408](apache/airflow#53408)) - Add `run_on_latest_version` support for backfill and clear operations ([#52177](apache/airflow#52177)) - Add `run_id_pattern` search for Dag Run API ([#52437](apache/airflow#52437)) - Add tracking of triggering user to Dag runs ([#51738](apache/airflow#51738)) - Expose DAG parsing duration in the API ([#54752](apache/airflow#54752)) ## New API Endpoints: - Add Human-in-the-Loop (HITL) endpoints for approval workflows ([#52868](apache/airflow#52868), [#53373](apache/airflow#53373), [#53376](apache/airflow#53376), [#53885](apache/airflow#53885), [#53923](apache/airflow#53923), [#54308](apache/airflow#54308), [#54310](apache/airflow#54310), [#54723](apache/airflow#54723), [#54773](apache/airflow#54773), [#55019](apache/airflow#55019), [#55463](apache/airflow#55463), [#55525](apache/airflow#55525), [#55535](apache/airflow#55535), [#55603](apache/airflow#55603), [#55776](apache/airflow#55776)) - Add endpoint to watch dag run until finish ([#51920](apache/airflow#51920)) - Add TI bulk actions endpoint ([#50443](apache/airflow#50443)) - Add Keycloak Refresh Token Endpoint ([#51657](apache/airflow#51657)) ## Deprecations: - Mark `DagDetailsResponse.concurrency` as deprecated ([#55150](apache/airflow#55150)) ## Bug Fixes: - Fix dag import error modal pagination ([#55719](apache/airflow#55719))

boring-cyborg bot added area:airflow-ctl area:API Airflow's REST/HTTP API area:db-migrations PRs with DB migration area:providers area:task-sdk area:Triggerer area:UI Related to UI/UX. For Frontend Developers. kind:documentation provider:standard labels Sep 10, 2025

Lee-W force-pushed the hitl-user branch 2 times, most recently from 0dac2b5 to 3bcd3f4 Compare September 10, 2025 15:13

Lee-W added this to AIP-90 - Human in the loop Sep 10, 2025

Lee-W added this to the Airflow 3.1.0 milestone Sep 10, 2025

Lee-W moved this to In progress in AIP-90 - Human in the loop Sep 10, 2025

Lee-W force-pushed the hitl-user branch 4 times, most recently from 3687694 to 979f477 Compare September 10, 2025 22:28

sjyangkevin reviewed Sep 11, 2025

View reviewed changes

airflow-core/tests/unit/api_fastapi/core_api/routes/public/test_hitl.py Show resolved Hide resolved

sjyangkevin reviewed Sep 11, 2025

View reviewed changes

airflow-core/tests/unit/api_fastapi/execution_api/versions/head/test_hitl.py Show resolved Hide resolved

sjyangkevin reviewed Sep 11, 2025

View reviewed changes

airflow-core/src/airflow/models/hitl.py Outdated Show resolved Hide resolved

sjyangkevin reviewed Sep 11, 2025

View reviewed changes

Lee-W force-pushed the hitl-user branch from 979f477 to 8bbda54 Compare September 11, 2025 14:19

Lee-W mentioned this pull request Sep 11, 2025

Display responder username for better audit. #55509

Merged

Lee-W force-pushed the hitl-user branch from 8bbda54 to f6c592d Compare September 11, 2025 15:16

Lee-W marked this pull request as ready for review September 11, 2025 15:17

Lee-W requested review from amoghrajesh, ashb and kaxil as code owners September 11, 2025 15:17

fixup! fixup! fixup! docs(hitl): add assigned_user to example

c1d0fd6

Lee-W force-pushed the hitl-user branch from fcb2d1f to c1d0fd6 Compare September 11, 2025 18:13

Lee-W merged commit 30c193b into apache:main Sep 11, 2025
107 checks passed

Lee-W deleted the hitl-user branch September 11, 2025 19:10

github-project-automation bot moved this from In review to Done in AIP-90 - Human in the loop Sep 11, 2025

kaxil pushed a commit that referenced this pull request Sep 15, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

7fef4a2

…user model (#55463) (cherry picked from commit 30c193b)

suman-himanshu pushed a commit to suman-himanshu/airflow that referenced this pull request Sep 17, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

98a3d2d

…user model (apache#55463)

Brunda10 pushed a commit to Brunda10/airflow that referenced this pull request Sep 17, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

fa67bbd

…user model (apache#55463)

eladkal mentioned this pull request Sep 18, 2025

Status of testing Providers that were prepared on September 18, 2025 #55831

Closed

78 tasks

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Sep 30, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

b3bdaa3

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 1, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

96955fa

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 2, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

22d160b

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 3, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

e6c54e9

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 4, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

71b3b27

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 5, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

3d53779

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 5, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

360d347

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 7, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

4a0724b

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 8, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

0ecd0e9

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 9, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

1450b92

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 10, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

971a510

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 11, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

d562d15

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 12, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

7a75cf2

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 14, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

ab0ee42

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 15, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

9570a8a

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 17, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

e1df524

…user model (apache#55463)

abdulrahman305 bot pushed a commit to abdulrahman305/airflow that referenced this pull request Oct 19, 2025

fix(hitl): make the user model in HITLDetail consistent with airflow …

f278cfd

…user model (apache#55463)

kaxil mentioned this pull request Oct 22, 2025

Update Python Client to 3.1.0 apache/airflow-client-python#138

Merged

potiuk mentioned this pull request Nov 8, 2025

Add missing translations for PL for 3.1.3 #58076

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(hitl): make the user model in HITLDetail consistent with airflow user model #55463

fix(hitl): make the user model in HITLDetail consistent with airflow user model #55463

Uh oh!

Lee-W commented Sep 10, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sjyangkevin left a comment

Uh oh!

Lee-W commented Sep 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fix(hitl): make the user model in HITLDetail consistent with airflow user model #55463

fix(hitl): make the user model in HITLDetail consistent with airflow user model #55463

Uh oh!

Conversation

Lee-W commented Sep 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why

What

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sjyangkevin left a comment

Choose a reason for hiding this comment

Uh oh!

Lee-W commented Sep 11, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Lee-W commented Sep 10, 2025 •

edited

Loading