|
33 | 33 | # serve to show the default. |
34 | 34 | import logging |
35 | 35 | import os |
36 | | -from pathlib import Path |
37 | 36 | from typing import Any |
38 | 37 |
|
39 | 38 | import rich |
|
47 | 46 | AUTOAPI_OPTIONS, |
48 | 47 | BASIC_AUTOAPI_IGNORE_PATTERNS, |
49 | 48 | BASIC_SPHINX_EXTENSIONS, |
50 | | - REDOC_SCRIPT_URL, |
51 | 49 | SMARTQUOTES_EXCLUDES, |
52 | 50 | SPELLING_WORDLIST_PATH, |
53 | 51 | SPHINX_DESIGN_STATIC_PATH, |
| 52 | + SPHINX_SWAGGER_EXTENSION, |
54 | 53 | SUPPRESS_WARNINGS, |
| 54 | + SWAGGER_BUNDLE_URI, |
| 55 | + SWAGGER_CSS_URI, |
| 56 | + SWAGGER_PRESENT_URI, |
55 | 57 | filter_autoapi_ignore_entries, |
56 | 58 | get_autodoc_mock_imports, |
57 | 59 | get_configs_and_deprecations, |
|
119 | 121 | # ones. |
120 | 122 | extensions = BASIC_SPHINX_EXTENSIONS |
121 | 123 |
|
122 | | -PROVIDER_PACKAGES_WITH_REDOC = ["apache-airflow-providers-fab", "apache-airflow-providers-keycloak"] |
123 | | - |
124 | | -if PACKAGE_NAME in PROVIDER_PACKAGES_WITH_REDOC: |
125 | | - extensions.extend( |
126 | | - [ |
127 | | - "autoapi.extension", |
128 | | - # First, generate redoc |
129 | | - "sphinxcontrib.redoc", |
130 | | - # Second, update redoc script |
131 | | - "sphinx_script_update", |
132 | | - ] |
133 | | - ) |
134 | | - redoc_script_url = REDOC_SCRIPT_URL |
135 | | -else: |
136 | | - extensions.extend( |
137 | | - [ |
138 | | - "autoapi.extension", |
139 | | - ] |
140 | | - ) |
| 124 | +PROVIDER_PACKAGES_WITH_API_REFERENCE = [ |
| 125 | + "apache-airflow-providers-edge3", |
| 126 | + "apache-airflow-providers-fab", |
| 127 | + "apache-airflow-providers-keycloak", |
| 128 | +] |
| 129 | + |
| 130 | +if PACKAGE_NAME in PROVIDER_PACKAGES_WITH_API_REFERENCE: |
| 131 | + extensions.append(SPHINX_SWAGGER_EXTENSION) |
| 132 | + |
| 133 | + swagger_present_uri = SWAGGER_PRESENT_URI |
| 134 | + swagger_bundle_uri = SWAGGER_BUNDLE_URI |
| 135 | + swagger_css_uri = SWAGGER_CSS_URI |
| 136 | + swagger_mirror_external_resources = True # Ensure we embed external resources prevent tracking |
| 137 | + |
| 138 | +extensions.append("autoapi.extension") |
141 | 139 |
|
142 | 140 | extensions.extend( |
143 | 141 | [ |
|
357 | 355 | spelling_ignore_importable_modules = True |
358 | 356 |
|
359 | 357 | graphviz_output_format = "svg" |
360 | | - |
361 | | -if PACKAGE_NAME in PROVIDER_PACKAGES_WITH_REDOC: |
362 | | - from airflow.providers.fab.auth_manager.api_fastapi.openapi import ( |
363 | | - __file__ as fab_auth_manager_fastapi_api_file, |
364 | | - ) |
365 | | - from airflow.providers.keycloak.auth_manager.openapi import ( |
366 | | - __file__ as keycloak_auth_manager_fastapi_api_file, |
367 | | - ) |
368 | | - |
369 | | - fab_auth_manager_fastapi_api_path = Path(fab_auth_manager_fastapi_api_file).parent.joinpath( |
370 | | - "v2-fab-auth-manager-generated.yaml" |
371 | | - ) |
372 | | - keycloak_auth_manager_fastapi_api_path = Path(keycloak_auth_manager_fastapi_api_file).parent.joinpath( |
373 | | - "v2-keycloak-auth-manager-generated.yaml" |
374 | | - ) |
375 | | - redoc = [ |
376 | | - { |
377 | | - "name": "Fab auth manager API", |
378 | | - "page": "api-ref/fab-api-ref", |
379 | | - "spec": fab_auth_manager_fastapi_api_path.as_posix(), |
380 | | - "opts": { |
381 | | - "hide-hostname": True, |
382 | | - "no-auto-auth": True, |
383 | | - }, |
384 | | - }, |
385 | | - { |
386 | | - "name": "Keycloak auth manager token API", |
387 | | - "page": "api-ref/token-api-ref", |
388 | | - "spec": keycloak_auth_manager_fastapi_api_path.as_posix(), |
389 | | - "opts": { |
390 | | - "hide-hostname": True, |
391 | | - "no-auto-auth": True, |
392 | | - }, |
393 | | - }, |
394 | | - ] |
0 commit comments