Skip to content

Move enable_swagger_ui config to api #50896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pierrejeambrun merged 2 commits into from
May 21, 2025
Merged

Move enable_swagger_ui config to api #50896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bf33b7c
Move enable_swagger_ui config to api
pierrejeambrun May 21, 2025
b44f08e
Fix CI
pierrejeambrun May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions airflow-core/src/airflow/api_fastapi/core_api/routes/ui/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,9 @@

config_router = AirflowRouter(tags=["Config"])

WEBSERVER_CONFIG_KEYS = [
"enable_swagger_ui",
]

API_CONFIG_KEYS = [
"enable_swagger_ui",
"hide_paused_dags_by_default",
"page_size",
"default_wrap",
Expand All @@ -50,9 +48,7 @@
)
def get_configs() -> ConfigResponse:
"""Get configs for UI."""
config = {key: conf.get("webserver", key) for key in WEBSERVER_CONFIG_KEYS}

config.update({key: conf.get("api", key) for key in API_CONFIG_KEYS})
config = {key: conf.get("api", key) for key in API_CONFIG_KEYS}

task_log_reader = TaskLogReader()
additional_config: dict[str, Any] = {
Expand Down
4 changes: 4 additions & 0 deletions airflow-core/src/airflow/cli/commands/config_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,10 @@ def message(self) -> str | None:
config=ConfigParameter("webserver", "grid_view_sorting_order"),
renamed_to=ConfigParameter("api", "grid_view_sorting_order"),
),
ConfigChange(
config=ConfigParameter("webserver", "enable_swagger_ui"),
renamed_to=ConfigParameter("api", "enable_swagger_ui"),
),
ConfigChange(
config=ConfigParameter("webserver", "error_logfile"),
was_deprecated=False,
Expand Down
14 changes: 7 additions & 7 deletions airflow-core/src/airflow/config_templates/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1284,6 +1284,13 @@ secrets:
api:
description: ~
options:
enable_swagger_ui:
description: |
Boolean for running SwaggerUI in the webserver.
version_added: 2.6.0
type: boolean
example: ~
default: "True"
secret_key:
description: |
Secret key used to run your api server. It should be as random as possible. However, when running
Expand Down Expand Up @@ -1787,13 +1794,6 @@ webserver:
type: string
example: "dagrun_cleared,failed"
default: ~
enable_swagger_ui:
description: |
Boolean for running SwaggerUI in the webserver.
version_added: 2.6.0
type: boolean
example: ~
default: "True"
email:
description: |
Configuration email backend and whether to
Expand Down
1 change: 1 addition & 0 deletions airflow-core/src/airflow/configuration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,6 +363,7 @@ def sensitive_config_values(self) -> set[tuple[str, str]]:
("fab", "navbar_hover_color"): ("webserver", "navbar_hover_color", "3.0.2"),
("fab", "navbar_text_hover_color"): ("webserver", "navbar_text_hover_color", "3.0.2"),
("api", "secret_key"): ("webserver", "secret_key", "3.0.2"),
("api", "enable_swagger_ui"): ("webserver", "enable_swagger_ui", "3.0.2"),
("api", "grid_view_sorting_order"): ("webserver", "grid_view_sorting_order", "3.1.0"),
("api", "log_fetch_timeout_sec"): ("webserver", "log_fetch_timeout_sec", "3.1.0"),
("api", "hide_paused_dags_by_default"): ("webserver", "hide_paused_dags_by_default", "3.1.0"),
Expand Down
2 changes: 1 addition & 1 deletion airflow-core/tests/unit/api_fastapi/core_api/routes/ui/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ def mock_config_data():
with conf_vars(
{
("webserver", "instance_name"): "Airflow",
("webserver", "enable_swagger_ui"): "true",
("api", "enable_swagger_ui"): "true",
("api", "hide_paused_dags_by_default"): "true",
("api", "page_size"): "100",
("api", "default_wrap"): "false",
Expand Down
2 changes: 1 addition & 1 deletion providers/fab/src/airflow/providers/fab/www/constants.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@
# There is a difference with configuring Swagger in Connexion 2.x and Connexion 3.x
# Connexion 2: https://connexion.readthedocs.io/en/2.14.2/quickstart.html#the-swagger-ui-console
# Connexion 3: https://connexion.readthedocs.io/en/stable/swagger_ui.html#configuring-the-swagger-ui
SWAGGER_ENABLED = conf.getboolean("webserver", "enable_swagger_ui", fallback=True)
SWAGGER_ENABLED = conf.getboolean("api", "enable_swagger_ui", fallback=True)
SWAGGER_BUNDLE = WWW.joinpath("static", "dist", "swagger-ui")
2 changes: 1 addition & 1 deletion providers/fab/www-hash.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
e6d566ed6f8c2b19eda800f6bb53b2bf7b3ede110978d3628e55f1e63f201704
c721979395879c5bc6be835a168a3fd354e99de9f11515580d04c402373fbc0f