Skip to content

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

@ankushpurwar

Description

@ankushpurwar

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions