Replace Sphinx Redoc with Swagger API Docs#67390
Open
jscheffl wants to merge 3 commits into
Open
Conversation
boring-cyborg
Bot
added
area:airflow-ctl
area:API
jscheffl
force-pushed
the
feature/replace-redoc-with-swagger
branch
from
4b3ec54 to
022ef55
Compare
jscheffl
force-pushed
the
feature/replace-redoc-with-swagger
branch
from
022ef55 to
fe0248c
Compare
jscheffl
commented
May 25, 2026
| SPHINX_SWAGGER_EXTENSION = "swagger_plugin_for_sphinx" | ||
|
|
||
|
|
||
| def mirror_artifact_locally(source_uri: str, doc_root: pathlib.Path) -> str: |
Contributor
Author
There was a problem hiding this comment.
Note: This will go-away with the next release of swagger-plugin-for-sphinx after SAP/swagger-plugin-for-sphinx#509
jscheffl
requested review from
bugraoz93,
dheerajturaga,
potiuk and
vincbeck
as code owners
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
As we have the Sphinx-Redoc issue with setuptools still not fixed and it seems the plugin is not maintained (see sphinx-contrib/redoc#54) this PR attempts to replace it with swagger. As this is better maintained.
DO NOT MERGE because:
What is does:
New look:
Was generative AI tooling used to co-author this PR?
{pr_number}.significant.rst, in airflow-core/newsfragments. You can add this file in a follow-up commit after the PR is created so you know the PR number.