API Endpoint for Airflow V1 - DAGs details
See original GitHub issueDescription
We need to have the endpoint in Airflow V1 to retrieve details of existing DAG, e.g. GET /dags/{dag_id}/details
Use case / motivation
We want to be able to retrieve/discover the parameters that a DAG accepts. We can see that you pass parameters when you execute a dag via the conf object. We can also see that you explicitly declare parameters that a DAG accepts via the params argument when creating the DAG. However, we can’t see anywhere via either the REST API or CLI that allows you to retrieve this information from a DAG (note that we are not saying a DAG run). It doesn’t even look like version 2 API supports this although the OpenAPI spec mentions a dags/{dag_id}/details endpoint but this is not documented. We found the related GitHub issue for this new endpoint and it is done but looks like documentation isn’t yet updated. Please can you:
- Provide the response for the v2 details endpoint
- Advise when v2 documentation will be updated with the details endpoint.
- Advise if there is a workaround for us doing this on v1.1
Related Issues
Issue Analytics
- State:
- Created 3 years ago
- Comments:22 (12 by maintainers)
Top GitHub Comments
I’d like to implement this if nobody minds
I agree. The
DAG.params
attribute should be available through the API.