Update FAB provider documentation #48247
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the FAB provider documentation to reflect the latest changes, including a new guide on generating a JWT token using the FAB auth manager for invoking the Airflow public API.
- Updates Sphinx configuration to conditionally include redoc-related extensions based on the package name.
- Adds dynamic resolution of OpenAPI specification file paths for the FAB provider, supporting both Flask and FastAPI endpoints.
Files not reviewed (10)
- airflow-core/docs/redirects.txt: Language not supported
- providers/fab/docs/api-ref/fab-public-api-ref.rst: Language not supported
- providers/fab/docs/api-ref/fab-token-api-ref.rst: Language not supported
- providers/fab/docs/auth-manager/access-control.rst: Language not supported
- providers/fab/docs/auth-manager/api-authentication.rst: Language not supported
- providers/fab/docs/auth-manager/index.rst: Language not supported
- providers/fab/docs/auth-manager/security.rst: Language not supported
- providers/fab/docs/auth-manager/token.rst: Language not supported
- providers/fab/docs/auth-manager/webserver-authentication.rst: Language not supported
- providers/fab/docs/index.rst: Language not supported
Comments suppressed due to low confidence (1)
docs/conf.py:926
- [nitpick] Consider renaming 'auth_manager_path' to a more descriptive name such as 'fab_auth_manager_file' to clarify it holds the module file path.
from airflow.providers.fab.auth_manager import __file__ as auth_manager_path
vincbeck
force-pushed
the
vincbeck/fab_doc
branch
5 times, most recently
from
05e128e to
dcad464
Compare
phanikumv
reviewed
Mar 26, 2025
vincbeck
force-pushed
the
vincbeck/fab_doc
branch
from
0fef72f to
93ba80e
Compare
bugraoz93
approved these changes
Mar 26, 2025
vincbeck
force-pushed
the
vincbeck/fab_doc
branch
from
93ba80e to
3caffdf
Compare
pankajkoti
pushed a commit
to astronomer/airflow
that referenced
this pull request
Mar 28, 2025
shubham-pyc
pushed a commit
to shubham-pyc/airflow
that referenced
this pull request
Apr 2, 2025
nailo2c
pushed a commit
to nailo2c/airflow
that referenced
this pull request
Apr 4, 2025
simonprydden
pushed a commit
to simonprydden/airflow
that referenced
this pull request
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update FAB provider documentation to reflect the changes made in the latest version (not yet released).
As part of this update I also added a new guide to explain how to generate a JWT token using FAB auth manager. This is essential for any user who wants to call Airflow public API with FAB auth manager. This is related to the auth backends thread in the dev email list. In a follow-up PR, I'll update airflow documentation to explain the user flow on how to call Airflow API. On that same topic, I also generated the documentation for the token API. This should make it easier for users to use it.
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.