From f186eaf36c56574af05987644d493bd89ad14d27 Mon Sep 17 00:00:00 2001 From: vincbeck Date: Mon, 10 Mar 2025 11:31:15 -0400 Subject: [PATCH] Update docs to reflect auth manager move to `api_fastapi` --- docs/apache-airflow/core-concepts/auth-manager/index.rst | 6 +++--- docs/apache-airflow/empty_plugin/empty_plugin.py | 2 +- docs/apache-airflow/public-airflow-interface.rst | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/apache-airflow/core-concepts/auth-manager/index.rst b/docs/apache-airflow/core-concepts/auth-manager/index.rst index dbc0f279ea6b4..dc973f1d5e7b5 100644 --- a/docs/apache-airflow/core-concepts/auth-manager/index.rst +++ b/docs/apache-airflow/core-concepts/auth-manager/index.rst @@ -79,7 +79,7 @@ All Airflow auth managers implement a common interface so that they are pluggabl to all abilities and integrations within Airflow. This interface is used across Airflow to perform all user authentication and user authorization related operation. -The public interface is :class:`~airflow.auth.managers.base_auth_manager.BaseAuthManager`. +The public interface is :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager`. You can look through the code for the most detailed and up to date interface, but some important highlights are outlined below. @@ -102,7 +102,7 @@ Authentication related BaseAuthManager methods Authorization related BaseAuthManager methods ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Most of authorization methods in :class:`~airflow.auth.managers.base_auth_manager.BaseAuthManager` look the same. +Most of authorization methods in :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager` look the same. Let's go over the different parameters used by most of these methods. * ``method``: Use HTTP method naming to determine the type of action being done on a specific resource. @@ -184,7 +184,7 @@ Endpoints defined by ``get_fastapi_app`` are mounted in ``/auth``. Next Steps ^^^^^^^^^^ -Once you have created a new auth manager class implementing the :class:`~airflow.auth.managers.base_auth_manager.BaseAuthManager` interface, you can configure Airflow to use it by setting the ``core.auth_manager`` configuration value to the module path of your auth manager: +Once you have created a new auth manager class implementing the :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager` interface, you can configure Airflow to use it by setting the ``core.auth_manager`` configuration value to the module path of your auth manager: .. code-block:: ini diff --git a/docs/apache-airflow/empty_plugin/empty_plugin.py b/docs/apache-airflow/empty_plugin/empty_plugin.py index ed5a99f1c9132..78da26c14c3e0 100644 --- a/docs/apache-airflow/empty_plugin/empty_plugin.py +++ b/docs/apache-airflow/empty_plugin/empty_plugin.py @@ -22,7 +22,7 @@ from flask import Blueprint from flask_appbuilder import BaseView, expose -from airflow.auth.managers.models.resource_details import AccessView +from airflow.api_fastapi.auth.managers.models.resource_details import AccessView from airflow.plugins_manager import AirflowPlugin from airflow.providers.fab.www.auth import has_access_view diff --git a/docs/apache-airflow/public-airflow-interface.rst b/docs/apache-airflow/public-airflow-interface.rst index d1012f5784ac5..53d6dfc5d7d96 100644 --- a/docs/apache-airflow/public-airflow-interface.rst +++ b/docs/apache-airflow/public-airflow-interface.rst @@ -328,9 +328,9 @@ Auth managers ------------- Auth managers are responsible of user authentication and user authorization in Airflow. All auth managers are -derived from :class:`~airflow.auth.managers.base_auth_manager.BaseAuthManager`. +derived from :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager`. -The auth manager interface itself (the :class:`~airflow.auth.managers.base_auth_manager.BaseAuthManager` class) is +The auth manager interface itself (the :class:`~airflow.api_fastapi.auth.managers.base_auth_manager.BaseAuthManager` class) is public, but the different implementations of auth managers are not (i.e. FabAuthManager). You can read more about auth managers and how to write your own in :doc:`core-concepts/auth-manager/index`.