This is an automated email from the ASF dual-hosted git repository.
pierrejeambrun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new 39d79fc513b Hide UI list backfills from documentation (#44871)
39d79fc513b is described below
commit 39d79fc513bd2fc365107a906f609d6a9f8909c1
Author: Pierre Jeambrun <[email protected]>
AuthorDate: Thu Dec 12 23:33:51 2024 +0800
Hide UI list backfills from documentation (#44871)
* Hide UI list backfills from documentation
* Move to the router definition
---
airflow/api_fastapi/core_api/routes/ui/__init__.py | 2 +-
airflow/api_fastapi/core_api/routes/ui/assets.py | 2 +-
airflow/api_fastapi/core_api/routes/ui/config.py | 1 -
airflow/api_fastapi/core_api/routes/ui/dags.py | 2 +-
airflow/api_fastapi/core_api/routes/ui/dashboard.py | 1 -
airflow/api_fastapi/core_api/routes/ui/structure.py | 1 -
6 files changed, 3 insertions(+), 6 deletions(-)
diff --git a/airflow/api_fastapi/core_api/routes/ui/__init__.py
b/airflow/api_fastapi/core_api/routes/ui/__init__.py
index 3d9850ba37e..38231ebd369 100644
--- a/airflow/api_fastapi/core_api/routes/ui/__init__.py
+++ b/airflow/api_fastapi/core_api/routes/ui/__init__.py
@@ -24,7 +24,7 @@ from airflow.api_fastapi.core_api.routes.ui.dags import
dags_router
from airflow.api_fastapi.core_api.routes.ui.dashboard import dashboard_router
from airflow.api_fastapi.core_api.routes.ui.structure import structure_router
-ui_router = AirflowRouter(prefix="/ui")
+ui_router = AirflowRouter(prefix="/ui", include_in_schema=False)
ui_router.include_router(assets_router)
ui_router.include_router(config_router)
diff --git a/airflow/api_fastapi/core_api/routes/ui/assets.py
b/airflow/api_fastapi/core_api/routes/ui/assets.py
index 1091b1962cd..97054793963 100644
--- a/airflow/api_fastapi/core_api/routes/ui/assets.py
+++ b/airflow/api_fastapi/core_api/routes/ui/assets.py
@@ -28,7 +28,7 @@ from airflow.models.asset import AssetDagRunQueue,
AssetEvent, AssetModel, DagSc
assets_router = AirflowRouter(tags=["Asset"])
-@assets_router.get("/next_run_assets/{dag_id}", include_in_schema=False)
+@assets_router.get("/next_run_assets/{dag_id}")
def next_run_assets(
dag_id: str,
request: Request,
diff --git a/airflow/api_fastapi/core_api/routes/ui/config.py
b/airflow/api_fastapi/core_api/routes/ui/config.py
index b395440ba08..e6e7c4b665d 100644
--- a/airflow/api_fastapi/core_api/routes/ui/config.py
+++ b/airflow/api_fastapi/core_api/routes/ui/config.py
@@ -48,7 +48,6 @@ WEBSERVER_CONFIG_KEYS = [
@config_router.get(
"/config",
- include_in_schema=False,
responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]),
)
def get_configs() -> ConfigResponse:
diff --git a/airflow/api_fastapi/core_api/routes/ui/dags.py
b/airflow/api_fastapi/core_api/routes/ui/dags.py
index 474cc817aa2..9a37df0f9f6 100644
--- a/airflow/api_fastapi/core_api/routes/ui/dags.py
+++ b/airflow/api_fastapi/core_api/routes/ui/dags.py
@@ -52,7 +52,7 @@ from airflow.models import DagModel, DagRun
dags_router = AirflowRouter(prefix="/dags", tags=["Dags"])
-@dags_router.get("/recent_dag_runs", include_in_schema=False,
response_model_exclude_none=True)
+@dags_router.get("/recent_dag_runs", response_model_exclude_none=True)
def recent_dag_runs(
limit: QueryLimit,
offset: QueryOffset,
diff --git a/airflow/api_fastapi/core_api/routes/ui/dashboard.py
b/airflow/api_fastapi/core_api/routes/ui/dashboard.py
index 980012db2a5..94489ed68ad 100644
--- a/airflow/api_fastapi/core_api/routes/ui/dashboard.py
+++ b/airflow/api_fastapi/core_api/routes/ui/dashboard.py
@@ -34,7 +34,6 @@ dashboard_router = AirflowRouter(tags=["Dashboard"],
prefix="/dashboard")
@dashboard_router.get(
"/historical_metrics_data",
- include_in_schema=False,
responses=create_openapi_http_exception_doc([status.HTTP_400_BAD_REQUEST]),
)
def historical_metrics(
diff --git a/airflow/api_fastapi/core_api/routes/ui/structure.py
b/airflow/api_fastapi/core_api/routes/ui/structure.py
index de142776ba9..3ac429cfa95 100644
--- a/airflow/api_fastapi/core_api/routes/ui/structure.py
+++ b/airflow/api_fastapi/core_api/routes/ui/structure.py
@@ -30,7 +30,6 @@ structure_router = AirflowRouter(tags=["Structure"],
prefix="/structure")
@structure_router.get(
"/structure_data",
- include_in_schema=False,
responses=create_openapi_http_exception_doc([status.HTTP_404_NOT_FOUND]),
)
def structure_data(
