How can I pass configuration options such as hideTestRequestButton to ScalarRenderPlugin OpenAPI?

[Macktireh]

Hello,

I'm using Litestar with ScalarRenderPlugin to generate my OpenAPI API documentation. I'd like to hide the "Test Request" button in the Scalar documentation, but I can't figure out how to pass the hideTestRequestButton option in the ScalarRenderPlugin configuration.

I've seen that this option exists in the Scalar configuration, as mentioned here:
https://guides.scalar.com/scalar/scalar-api-references/configuration#list-of-all-attributes__hidetestrequestbutton-boolean

I've tried adding it directly to ScalarRenderPlugin, but it doesn't seem to work as it's not a supported parameter.

Here is my current configuration:

from litestar.openapi.plugins import ScalarRenderPlugin
from litestar.openapi.spec import Contact, Server, Tag

openapi_config = OpenAPIConfig(
    title="API Docs",
    version="1.0.0",
    description="...",
    contact=Contact(name="The Team", email="..."),
    path="/",
    servers=[Server(url="http://localhost:8000", description="Local server")],
    tags=[
        Tag(name="Health", description="Health check and monitoring endpoints"),
    ],
    render_plugins=[ScalarRenderPlugin()],
)

Could you please let me know if it's possible to add this option, or if it would need to be added to ScalarRenderPlugin?

Thanks in advance for your help.

[provinzkraut]

This is currently not supported, but would be a useful feature. If you want you can open an issue / PR :)

[JacobCoffee]

I think actually this is @provinzkraut, via options:

scalar_plugin = ScalarRenderPlugin(
    path="/scalar",
    options={
        "hideTestRequestButton": True,
    }
)

[JacobCoffee]

Here's a cutesy example app:

from litestar import Litestar, get
from litestar.openapi.config import OpenAPIConfig
from litestar.openapi.plugins import ScalarRenderPlugin
from litestar.openapi.spec import Contact, Server, Tag


@get("/")
async def hello_world() -> dict[str, str]:
    """A simple hello world endpoint."""
    return {"message": "Hello World!"}


@get("/health")
async def health_check() -> dict[str, str]:
    """Health check endpoint."""
    return {"status": "healthy"}


@get("/users/{user_id:int}")
async def get_user(user_id: int) -> dict[str, str | int]:
    """Get user by ID."""
    return {"user_id": user_id, "name": f"User {user_id}"}


# Create ScalarRenderPlugin with hideTestRequestButton option
scalar_plugin = ScalarRenderPlugin(
    path="/scalar",
    options={
        "hideTestRequestButton": True,
    }
)

scalar_plugin_with_button = ScalarRenderPlugin(
    path="/scalar-with-button",
    options={
        "hideTestRequestButton": False,  # Explicitly show the button
    }
)


openapi_config = OpenAPIConfig(
    title="Test API - Hide Test Button Demo",
    version="1.0.0",
    description="Testing hideTestRequestButton option in Scalar. Visit /scalar (button hidden) vs /scalar-with-button (button shown)",
    contact=Contact(name="Test Team", email="[email protected]"),
    path="/schema",
    servers=[Server(url="http://localhost:8000", description="Local server")],
    tags=[
        Tag(name="Health", description="Health check and monitoring endpoints"),
        Tag(name="Users", description="User management endpoints"),
        Tag(name="General", description="General endpoints"),
    ],
    render_plugins=[scalar_plugin, scalar_plugin_with_button],
)

app = Litestar(
    route_handlers=[hello_world, health_check, get_user],
    openapi_config=openapi_config,
)