Skip to content

Support Query in GetHITLDetails Public api#53376

Merged
Lee-W merged 3 commits intoapache:mainfrom
astronomer:support-query-in-hitl-details-public-api
Jul 23, 2025
Merged

Support Query in GetHITLDetails Public api#53376
Lee-W merged 3 commits intoapache:mainfrom
astronomer:support-query-in-hitl-details-public-api

Conversation

@Lee-W
Copy link
Member

@Lee-W Lee-W commented Jul 15, 2025 •
edited
Loading

Why

Closes: #53178

What

feat(hitl): add filters and order by to get_hitl_details public API

  • filter: dag_id_pattern, dag_run_id, state, response_recevied, user_id, subject_search, body_search
  • sort_by: ti_id, subject, response_at, dag_id, run_id

^ 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.

@boring-cyborg boring-cyborg bot added area:airflow-ctl area:API Airflow's REST/HTTP API area:dev-tools backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch labels Jul 15, 2025
@Lee-W
Copy link
Member Author

Lee-W commented Jul 15, 2025

Hey @guan404ming , I added a few queries and filters. Could you please check and maybe play with it and see whether we miss anything? Thanks!

@guan404ming
Copy link
Member

guan404ming commented Jul 15, 2025

Thanks! Overall looks good, just like what we discussed offline. Should we also add sort by response_at to let users see the latest/earliest HITL response at the top?

@Lee-W Lee-W force-pushed the support-query-in-hitl-details-public-api branch 3 times, most recently from 162edc5 to 72b871c Compare July 19, 2025 14:18
@Lee-W Lee-W removed the backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch label Jul 20, 2025
@Lee-W Lee-W force-pushed the support-query-in-hitl-details-public-api branch 3 times, most recently from 4511667 to 4b2eb13 Compare July 20, 2025 19:36
@Lee-W Lee-W changed the title Support query in hitl details public api Support Query in GetHITLDetails Public api Jul 20, 2025
@Lee-W Lee-W marked this pull request as ready for review July 20, 2025 19:37
@Lee-W Lee-W force-pushed the support-query-in-hitl-details-public-api branch from 4b2eb13 to a627328 Compare July 20, 2025 19:38
@Lee-W
Copy link
Member Author

Lee-W commented Jul 20, 2025

Thanks! Overall looks good, just like what we discussed offline. Should we also add sort by response_at to let users see the latest/earliest HITL response at the top?

Sounds good. Added

@Lee-W Lee-W moved this to In review in AIP-90 - Human in the loop Jul 20, 2025
@Lee-W Lee-W self-assigned this Jul 20, 2025
@Lee-W Lee-W force-pushed the support-query-in-hitl-details-public-api branch from a627328 to b1695ba Compare July 20, 2025 20:32
@guan404ming guan404ming mentioned this pull request Jul 20, 2025
Merged
pierrejeambrun
pierrejeambrun approved these changes Jul 22, 2025
View reviewed changes
Copy link
Member

@pierrejeambrun pierrejeambrun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks.

Just one minor comment.

jason810496
jason810496 approved these changes Jul 22, 2025
View reviewed changes
Copy link
Member

@jason810496 jason810496 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT, same nit for the mistake comment.

@Lee-W Lee-W force-pushed the support-query-in-hitl-details-public-api branch from b1695ba to 845fc47 Compare July 22, 2025 23:14
@Lee-W Lee-W merged commit e61e961 into apache:main Jul 23, 2025
102 checks passed
@Lee-W Lee-W deleted the support-query-in-hitl-details-public-api branch July 23, 2025 06:40
@github-project-automation github-project-automation bot moved this from In review to Done in AIP-90 - Human in the loop Jul 23, 2025
kaxil added a commit to apache/airflow-client-python that referenced this pull request Oct 22, 2025
@kaxil
Update Python Client to 3.1.0rc1
e62c042 
(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))
@kaxil kaxil mentioned this pull request Oct 22, 2025
Merged
kaxil added a commit to apache/airflow-client-python that referenced this pull request Oct 23, 2025
@kaxil
Update Python Client to 3.1.0rc1 (#138)
241405e 
(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))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pierrejeambrun pierrejeambrun pierrejeambrun approved these changes

@jason810496 jason810496 jason810496 approved these changes

@bbovenzi bbovenzi Awaiting requested review from bbovenzi bbovenzi is a code owner

@ryanahamilton ryanahamilton Awaiting requested review from ryanahamilton ryanahamilton is a code owner

@jscheffl jscheffl Awaiting requested review from jscheffl

@shubhamraj-git shubhamraj-git Awaiting requested review from shubhamraj-git shubhamraj-git is a code owner

@ephraimbuddy ephraimbuddy Awaiting requested review from ephraimbuddy ephraimbuddy is a code owner

@rawwar rawwar Awaiting requested review from rawwar rawwar is a code owner

@bugraoz93 bugraoz93 Awaiting requested review from bugraoz93 bugraoz93 is a code owner

@XD-DENG XD-DENG Awaiting requested review from XD-DENG XD-DENG is a code owner

@ashb ashb Awaiting requested review from ashb ashb is a code owner

Assignees

@Lee-W Lee-W

Labels

area:airflow-ctl area:API Airflow's REST/HTTP API area:dev-tools

Projects

AIP-90 - Human in the loop
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Query Support for HITL-details endpoints

4 participants

@Lee-W @guan404ming @pierrejeambrun @jason810496