Airflow REST API: Add generic capability to retrieve required information for the specified entity..
#29.893 aberto em 3 de mar. de 2023
Métricas do repositório
- Stars
- (44.809 stars)
- Métricas de merge de PR
- (Mesclagem média 7d 18h) (834 fundiu PRs em 30d)
Description
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
- Optimize the information what we want to retrieve from server.
- Saving Network bandwidth by reducing the information to required one.
- 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
- I agree to follow this project's Code of Conduct