Skip to content

Releases: apache/airflow-client-python

Apache Airflow Python Client 3.2.1

27 Apr 12:34
6c76b5d

Choose a tag to compare

Bug Fixes:

  • Fix: use Dag form when materializing asset (#64211

Apache Airflow Python Client 3.2.0

13 Apr 12:33

Choose a tag to compare

New Features:

  • Add Asset Partitioning support: backfill for partitioned DAGs (#61464)
  • Add partition_key to DagRunAssetReference (#61725)
  • Add partition key column and filter to DAG Runs list (#61939)
  • Add DagRunType for asset materializations (#62276)
  • Add allowed_run_types to allowlist specific DAG run types (#61833)
  • Add DAG runs filters by bundleVersion (#62810)
  • Expose timetable_partitioned in UI API (#62777)
  • Add base React plugin destination (#62530)
  • Add team_name to Pool APIs (#60952)
  • Add team_name to connection public APIs (#59336)
  • Add team_id to variable APIs (#57102)
  • Add team selector to list variables and list connections pages (#60995)
  • Support OR operator in search parameters (#60008)
  • Add wildcard support for dag_id and dag_run_id in bulk task instance endpoint (#57441)
  • Add operator_name_pattern, pool_pattern, queue_pattern as search filters for task instances (#57571)
  • Add filters to Task Instances tab (#56920)
  • Add API support for filtering DAGs by timetable type (#58852)
  • Enable triggerer queues (#59239)
  • Add ability to add, edit, and delete XComs directly from UI (#58921)
  • Add HITL detail history (#55952, #56760)
  • Add update_mask support for bulk PATCH APIs (#54597)
  • Introduce named asset watchers (#55643)
  • Add DAG ID pattern search functionality to DAG Runs and Task Instances (#55691)
  • Add UI to allow creation of DAG Runs with partition key (#58004)
  • Support retry multiplier parameter (#56866)
  • Display active DAG runs count in header with auto-refresh (#58332)
  • Add checkbox before clear task confirmation to prevent rerun of tasks in Running state (#56351)

Improvements:

  • Upgrade FastAPI and conform OpenAPI schema changes (#61476)
  • Use SQLAlchemy native Uuid/JSON types instead of sqlalchemy-utils (#61532)
  • Remove team ID and use team name as primary key (#59109)
  • Update BulkDeleteAction to use generic type (#59207)
  • Add link to API docs (#53346)

Bug Fixes:

  • Fix null dag_run_conf in BackfillResponse serialization (#63259)
  • Fix missing dag_id filter on DAG Run query (#62750)
  • Fix HITLResponse data model name (#57795)
  • Remove unused parameter in logout (#58045)

Apache Airflow Python Client 3.1.8

28 Mar 17:58
b336f73

Choose a tag to compare

Bug Fixes:

Apache Airflow Python Client 3.1.6

22 Jan 09:51
3.1.6
df92326

Choose a tag to compare

Bug Fixes:

3.1.3

25 Nov 08:16
3.1.3
7a2ccc6

Choose a tag to compare

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

29 Oct 17:32
241405e

Choose a tag to compare

New Features:

  • Add map_index filter to TaskInstance API queries (#55614)
  • Add has_import_errors filter to Core API GET /dags endpoint (#54563)
  • Add dag_version filter 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_number as 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_version support for backfill and clear operations (#52177)
  • Add run_id_pattern search 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:

Deprecations:

  • Mark DagDetailsResponse.concurrency as deprecated (#55150)

Bug Fixes:

  • Fix dag import error modal pagination (#55719)

3.0.2

13 Jun 11:54
d71f13a

Choose a tag to compare

Major changes

  • Add owner_links field to DAGDetailsResponse (#50557)
  • Allow non-string valid JSON values in Variable import (#49844)
  • Add bundle_version to DagRun response (#49726)
  • Use NonNegativeInt for backfill_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_run nullable in Details page (#50719)

Bug Fixes

  • Fix OpenAPI schema for get_log API (#50547)
  • Fix bulk action annotation (#50852)
  • Fix patch_task_instance endpoint (#50550)

3.0.0

27 May 10:42
cb15507

Choose a tag to compare

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 Entity for validation errors (e.g. bad payload, path params, or query params), instead of 400 Bad Request.

  • Partial response support removed (fields parameter)

    Endpoints like GET /dags no longer support the fields query 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 exploded to form, exploded i.e before ?my_list=item1,item2 now ?my_list=item1&my_list=item2

  • execution_date has been removed

    The previously deprecated execution_date parameter and fields are now fully removed. Use logical_date instead.

  • Datetime format updated to RFC3339-compliant

    Datetimes returned are now in RFC3339 format (e.g. 2024-10-01T13:00:00Z). Both Z and +00:00 forms are accepted in inputs.
    → This change comes from FastAPI & Pydantic v2 behavior.
    More info

  • PATCH on DagRun and TaskInstance are more generic and allow in addition to update the resource state and the note content.

    Therefore, the two legacy dedicated endpoints to update a DagRun note and TaskInstance note have been removed.

    Same for the set task instance state, it is now handled by the broader PATCH on task instances.

  • assets/queuedEvent endpoints have moved to assets/queuedEvents for consistency.

  • dag_parsing returns 409 for duplicates

    If a DagPriorityParsingRequest already exists, POST /dag_parsing now returns 409 Conflict instead of 201 Created.

  • Default value change in clearTaskInstances

    The reset_dag_runs field now defaults to true instead of false.

  • 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_date is now a required nullable field

    When triggering a DAG run (POST /dags/{dag_id}/dagRuns), logical_date is now required but can explicitly be set to null.

2.10.0

30 Aug 16:33
2.10.0
f06831c

Choose a tag to compare

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

29 Jul 14:49
2.9.1
35ee071

Choose a tag to compare

Major changes:

  • Add max_consecutive_failed_dag_runs in API spec (#39830)