Update simple auth manager documentation to include token API #48454
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
vincbeck
requested review from
Copilot and
pierrejeambrun
and removed request for
potiuk
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation configuration for the simple auth manager token API and refreshes the API documentation for both the Apache Airflow and Fab auth managers. Key changes include:
- Adding a new Redoc entry for the simple auth manager token API using its generated OpenAPI spec.
- Updating the Redoc configuration for the Apache Airflow REST API and Fab auth manager API to use module-inferred paths.
Files not reviewed (5)
- airflow-core/docs/core-concepts/auth-manager/index.rst: Language not supported
- airflow-core/docs/core-concepts/auth-manager/simple/index.rst: Language not supported
- airflow-core/docs/core-concepts/auth-manager/simple/sam-token-api-ref.rst: Language not supported
- airflow-core/docs/core-concepts/auth-manager/simple/token.rst: Language not supported
- providers/fab/docs/auth-manager/token.rst: Language not supported
Comments suppressed due to low confidence (2)
docs/conf.py:906
- [nitpick] Consider renaming the alias 'sam_openapi_file' to a more descriptive name such as 'simple_auth_manager_openapi_file' for improved readability.
from airflow.api_fastapi.auth.managers.simple.openapi import __file__ as sam_openapi_file
docs/conf.py:932
- [nitpick] Consider renaming 'fab_auth_manager_fastapi_api_file' to 'fab_auth_manager_fastapi_openapi_file' to clearly indicate that this file relates to the OpenAPI specification.
from airflow.providers.fab.auth_manager.api_fastapi.openapi import (__file__ as fab_auth_manager_fastapi_api_file,)
vincbeck
force-pushed
the
vincbeck/doc_simple_am
branch
from
edec48c to
9f8613c
Compare
sunank200
pushed a commit
to astronomer/airflow
that referenced
this pull request
Mar 28, 2025
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
2 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.
Add documentation about how to generate a JWT token using simple auth manager. I also generate the API documentation for the simple auth manager token API.
^ 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 airflow-core/newsfragments.