(superset) 01/01: docs: document FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT config flag

[ru...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rusackas pushed a commit to branch fix/from-pr-40908-needs-docs-fix-swagger-support-url-prefi
in repository https://gitbox.apache.org/repos/asf/superset.git

commit 1bb3fe4b91f789574546db78c0cb43d5ea70cfc0
Author: rusackas <ev...@rusackas.com>
AuthorDate: Mon Aug 10 12:52:19 2026 -0700

    docs: document FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT config flag
    
    PR #40908 adds this flag to enable an APPLICATION_ROOT-aware Swagger UI
    for reverse-proxy/URL-prefix deployments, but the configuring-superset
    docs never mention it. Add it alongside the existing application-root
    docs.
    
    Co-Authored-By: Claude Sonnet 5 <no...@anthropic.com>
---
 docs/admin_docs/configuration/configuring-superset.mdx | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/admin_docs/configuration/configuring-superset.mdx b/docs/admin_docs/configuration/configuring-superset.mdx
index eaa5e99f0ed..b49416f9009 100644
--- a/docs/admin_docs/configuration/configuring-superset.mdx
+++ b/docs/admin_docs/configuration/configuring-superset.mdx
@@ -307,6 +307,22 @@ to simplify the process of setting up a non-default root path across the service
 In `docker/.env-local` set `SUPERSET_APP_ROOT` to the desired prefix and then bring the
 services up with `docker compose up --detach`.
 
+### Swagger UI
+
+By default, Superset's Swagger UI and OpenAPI spec (enabled via `FAB_API_SWAGGER_UI`) are
+served by Flask-AppBuilder and don't account for a non-root `APPLICATION_ROOT` prefix. If
+you're running Superset behind a URL prefix and want the Swagger UI and OpenAPI spec to
+resolve correctly, set:
+
+```python
+FAB_API_SWAGGER_UI_SUPERSET_APP_ROOT = True
+```
+
+in your `superset_config.py` file. This serves an `APPLICATION_ROOT`-aware Swagger UI and
+OpenAPI spec at `/swagger/<version>` and `/api/<version>/_openapi` respectively, resolved
+through the configured prefix. This flag only takes effect when `FAB_API_SWAGGER_UI` is
+also enabled, and defaults to `False`.
+
 ## Custom OAuth2 Configuration
 
 Superset is built on Flask-AppBuilder (FAB), which supports many providers out of the box