feat: return all available page-style endpoints on index

Author: Eoic

papyrus/main.py

@@ -149,6 +149,28 @@ async def general_exception_handler(request: Request, exc: Exception) -> JSONRes
     if settings.debug:
         include_debug_routers(app)
 
+    @app.get("/", tags=["Index"])
+    async def index(request: Request) -> dict[str, object]:
+        """Return the available page-style endpoints for this server."""
+        pages: list[dict[str, str]] = []
+
+        if app.docs_url is not None:
+            pages.append({"name": "docs", "path": app.docs_url})
+
+        if app.redoc_url is not None:
+            pages.append({"name": "redoc", "path": app.redoc_url})
+
+        if app.openapi_url is not None:
+            pages.append({"name": "openapi", "path": app.openapi_url})
+
+        if any(route.path == "/__dev/auth-sandbox" for route in request.app.routes):
+            pages.append({"name": "auth_sandbox", "path": "/__dev/auth-sandbox"})
+
+        return {
+            "name": "Papyrus Server API",
+            "pages": pages,
+        }
+
     @app.get("/health", tags=["Health"])
     async def health_check() -> dict[str, str]:
         """Check API health status."""

tests/api/routes/test_health.py

@@ -3,6 +3,30 @@
 from httpx import AsyncClient
 
 
+async def test_index_lists_available_pages(prod_client: AsyncClient):
+    """Test root index returns the available page endpoints."""
+    response = await prod_client.get("/")
+    assert response.status_code == 200
+    data = response.json()
+
+    pages = {page["name"]: page["path"] for page in data["pages"]}
+    assert data["name"] == "Papyrus Server API"
+    assert pages["docs"] == "/docs"
+    assert pages["redoc"] == "/redoc"
+    assert pages["openapi"] == "/openapi.json"
+    assert "auth_sandbox" not in pages
+
+
+async def test_index_lists_debug_pages(debug_client: AsyncClient):
+    """Test root index includes the auth sandbox in debug mode."""
+    response = await debug_client.get("/")
+    assert response.status_code == 200
+    data = response.json()
+
+    pages = {page["name"]: page["path"] for page in data["pages"]}
+    assert pages["auth_sandbox"] == "/__dev/auth-sandbox"
+
+
 async def test_health_check(client: AsyncClient):
     """Test health check endpoint."""
     response = await client.get("/health")