Releases: apache/airflow-client-python
3.1.3
New Features
Add query limit protection to prevent excessive database queries in DAG runs list endpoints (#57450)
Change extra field type to dict[str, JsonValue] for Asset, AssetAlias, and AssetEvent models (#57352)
Add task_display_name alias field to EventLogResponse for better task identification (#55160)
Add is_favorite field to DAGs list API to support user-specific DAG favorites (#56341)
Improvements
Enhance API documentation for sorting functionality (#56617)
Improve API documentation for the order_by query parameter (#55988)
Remove deprecated dagReports API endpoint (#56609)
Bug Fixes
Fix logout functionality in airflow-core to properly handle session termination (#57990)
Fix API endpoint for clearing task instances to properly support mapped task instances with specific map indexes (#56346)
3.1.0
New Features:
- Add
map_indexfilter to TaskInstance API queries (#55614) - Add
has_import_errorsfilter to Core API GET /dags endpoint (#54563) - Add
dag_versionfilter to get_dag_runs endpoint (#54882) - Implement pattern search for event log endpoint (#55114)
- Add asset-based filtering support to DAG API endpoint (#54263)
- Add Greater Than and Less Than range filters to DagRuns and Task Instance list (#54302)
- Add
try_numberas filter to task instances (#54695) - Add filters to Browse XComs endpoint (#54049)
- Add Filtering by DAG Bundle Name and Version to API routes (#54004)
- Add search filter for DAG runs by triggering user name (#53652)
- Enable multi sorting (AIP-84) (#53408)
- Add
run_on_latest_versionsupport for backfill and clear operations (#52177) - Add
run_id_patternsearch for Dag Run API (#52437) - Add tracking of triggering user to Dag runs (#51738)
- Expose DAG parsing duration in the API (#54752)
New API Endpoints:
- Add Human-in-the-Loop (HITL) endpoints for approval workflows (#52868, #53373, #53376, #53885, #53923, #54308, #54310, #54723, #54773, #55019, #55463, #55525, #55535, #55603, #55776)
- Add endpoint to watch dag run until finish (#51920)
- Add TI bulk actions endpoint (#50443)
- Add Keycloak Refresh Token Endpoint (#51657)
Deprecations:
- Mark
DagDetailsResponse.concurrencyas deprecated (#55150)
Bug Fixes:
- Fix dag import error modal pagination (#55719)
3.0.2
Major changes
- Add
owner_linksfield to DAGDetailsResponse (#50557) - Allow non-string valid JSON values in Variable import (#49844)
- Add
bundle_versionto DagRun response (#49726) - Use
NonNegativeIntforbackfill_id(#49691) - Rename operation IDs for task instance endpoints to include map indexes (#49608)
- Remove filtering by last dag run state in patch dags endpoint (#51176)
- Make
dag_runnullable in Details page (#50719)
Bug Fixes
3.0.0
This is the first release of the Airflow 3.0.0 Python client. It introduces compatibility with the new Airflow 3.0 REST API, and includes several breaking changes and behavior updates.
Below is a list of important changes. Refer to individual endpoint documentation for full details.
-
API v1 (
/api/v1) has been dropped and replaced with API v2(/api/v2). -
422 Validation Errors (instead of 400)
The API now returns
422 Unprocessable Entityfor validation errors (e.g. bad payload, path params, or query params), instead of400 Bad Request. -
Partial response support removed (
fieldsparameter)Endpoints like
GET /dagsno longer support thefieldsquery param for partial responses. Full objects are returned by default. This feature may return in a future 3.x release. -
Passing list in query parameters switched from
form, non explodedtoform, explodedi.e before?my_list=item1,item2now?my_list=item1&my_list=item2 -
execution_datehas been removedThe previously deprecated
execution_dateparameter and fields are now fully removed. Uselogical_dateinstead. -
Datetime format updated to RFC3339-compliant
Datetimes returned are now in RFC3339 format (e.g.
2024-10-01T13:00:00Z). BothZand+00:00forms are accepted in inputs.
→ This change comes from FastAPI & Pydantic v2 behavior.
More info -
PATCH on
DagRunandTaskInstanceare more generic and allow in addition to update the resource state and the note content.Therefore, the two legacy dedicated endpoints to update a
DagRunnote andTaskInstancenote have been removed.Same for the set task instance state, it is now handled by the broader PATCH on task instances.
-
assets/queuedEventendpoints have moved toassets/queuedEventsfor consistency. -
dag_parsingreturns 409 for duplicatesIf a
DagPriorityParsingRequestalready exists,POST /dag_parsingnow returns409 Conflictinstead of201 Created. -
Default value change in
clearTaskInstancesThe
reset_dag_runsfield now defaults totrueinstead offalse. -
Pool name is no longer editable
PATCH /pools/{pool_name}can no longer be used to rename a pool. Pool names are immutable via the API. -
logical_dateis now a required nullable fieldWhen triggering a DAG run (
POST /dags/{dag_id}/dagRuns),logical_dateis now required but can explicitly be set tonull.
2.10.0
Major changes:
- Add dag_stats rest api endpoint (#41017)
- AIP-64: Add task instance history list endpoint (#40988)
- Change DAG Audit log tab to Event Log (#40967)
- AIP-64: Add REST API endpoints for TI try level details (#40441)
- Make XCom display as react json (#40640)
- Replace usages of task context logger with the log table (#40867)
- Fix tasks API endpoint when DAG doesn't have
start_date(#40878) - Add try_number to log table (#40739)
- Add executor field to the task instance API (#40034)
- Add task documentation to details tab in grid view. (#39899)
- Add max_consecutive_failed_dag_runs in API spec (#39830)
- Add task failed dependencies to details page. (#38449)
- Add dag re-parsing request endpoint (#39138)
- Reorder OpenAPI Spec tags alphabetically (#38717)
2.9.1
2.9.0
Major changes:
- Allow users to write dag_id and task_id in their national characters, added display name for dag / task (v2) (#38446)
- Add dataset_expression to grid dag details (#38121)
- Adding run_id column to log table (#37731)
- Show custom instance names for a mapped task in UI (#36797)
- Add excluded/included events to get_event_logs api (#37641)
- Filter Datasets by associated dag_ids (GET /datasets) (#37512)
- Add data_interval_start and data_interval_end in dagrun create API endpoint (#36630)
- Return the specified field when get dag/dagRun (#36641)
NEW API supported
Airflow Python Client v2.8.0
v2.8.0
Major changes:
- Allow filtering event logs by attributes (#34417)
- Add extra fields to plugins endpoint (#34913)
- Let auth managers provide their own API endpoints (#34349)
- Enable pools to consider deferred tasks (#32709)
- Add dag_run_ids and task_ids filter for the batch task instance API endpoint (#32705)
Major Fixes
- Add DagModel attributes before dumping DagDetailSchema for get_dag_details API endpoint (#34947)
- Add TriggerRule missing value in rest API (#35194)
- Fix wrong plugin schema (#34858)
- Make dry run optional for patch task instance (#34568)
- OpenAPI Spec fix nullable alongside $ref (#32887)
- Clarify new_state in OpenAPI spec (#34056)
NEW API supported
- NA
Airflow Python Client v2.7.3
Apache Airflow API 2.7.2
Major changes:
- NA
Major Fixes
- Fix: make dry run optional for patch task instance (#34568)
NEW API supported
- NA