apache/airflow

Airflow REST API: Add generic capability to retrieve required information for the specified entity..

Open

#29,893 创建于 2023年3月3日

在 GitHub 查看
 (15 评论) (0 反应) (0 负责人)Python (16,781 fork)batch import
area:APIgood first issuekind:feature

仓库指标

Star
 (44,809 star)
PR 合并指标
 (平均合并 7天 18小时) (30 天内合并 834 个 PR)

描述

Description

Airflow REST API should add a generic capability to retrieve the required information only. Instead sending all of them. E.g. If I want to retrieve DAG Run details using REST API: https://airflow.apache.org/api/v1/dags/{dag_id}/dagRuns/{dag_run_id} Or want to fetch list of DAGs using RET API: https://airflow.apache.org/api/v1/dags

It always returns the full details. Often it is the case where caller is not interested in all the information.

So I suggest to add a generic capability to retrieve only needed information just like offset and limit. E.g. if we pass fields = {dag_id, is_paused} in the query parameter while calling https://airflow.apache.org/api/v1/dags API, So it returns JSON body contains {dag_id, is_paused} fields.

Similarly it is true for other end points as well (At least Get Ones)

Use case/motivation

  1. Optimize the information what we want to retrieve from server.
  2. Saving Network bandwidth by reducing the information to required one.
  3. Possibility to collect more data in one go.

Related issues

Cannot say.

Are you willing to submit a PR?

  • Yes I am willing to submit a PR!

Code of Conduct

贡献者指南