From 9ec585dfaf260f09e9aaa3e097aeec733e568404 Mon Sep 17 00:00:00 2001 From: Krrish Dholakia Date: Fri, 31 May 2024 22:06:25 -0700 Subject: [PATCH] docs(proxy_server.py): add link to customize swagger docs on base url --- litellm/proxy/_experimental/out/{404.html => 404/index.html} | 0 .../out/{model_hub.html => model_hub/index.html} | 0 .../out/{onboarding.html => onboarding/index.html} | 0 litellm/proxy/proxy_server.py | 5 +++-- 4 files changed, 3 insertions(+), 2 deletions(-) rename litellm/proxy/_experimental/out/{404.html => 404/index.html} (100%) rename litellm/proxy/_experimental/out/{model_hub.html => model_hub/index.html} (100%) rename litellm/proxy/_experimental/out/{onboarding.html => onboarding/index.html} (100%) diff --git a/litellm/proxy/_experimental/out/404.html b/litellm/proxy/_experimental/out/404/index.html similarity index 100% rename from litellm/proxy/_experimental/out/404.html rename to litellm/proxy/_experimental/out/404/index.html diff --git a/litellm/proxy/_experimental/out/model_hub.html b/litellm/proxy/_experimental/out/model_hub/index.html similarity index 100% rename from litellm/proxy/_experimental/out/model_hub.html rename to litellm/proxy/_experimental/out/model_hub/index.html diff --git a/litellm/proxy/_experimental/out/onboarding.html b/litellm/proxy/_experimental/out/onboarding/index.html similarity index 100% rename from litellm/proxy/_experimental/out/onboarding.html rename to litellm/proxy/_experimental/out/onboarding/index.html diff --git a/litellm/proxy/proxy_server.py b/litellm/proxy/proxy_server.py index 1552e99985..1ff38578a3 100644 --- a/litellm/proxy/proxy_server.py +++ b/litellm/proxy/proxy_server.py @@ -196,6 +196,7 @@ ui_link = f"/ui/" ui_message = ( f"👉 [```LiteLLM Admin Panel on /ui```]({ui_link}). Create, Edit Keys with SSO" ) +custom_swagger_message = f"[**Customize Swagger Docs**](https://docs.litellm.ai/docs/proxy/enterprise#swagger-docs---custom-routes--branding)" ### CUSTOM BRANDING [ENTERPRISE FEATURE] ### _docs_url = None if os.getenv("NO_DOCS", "False") == "True" else "/" @@ -203,10 +204,10 @@ _title = os.getenv("DOCS_TITLE", "LiteLLM API") if premium_user else "LiteLLM AP _description = ( os.getenv( "DOCS_DESCRIPTION", - f"Proxy Server to call 100+ LLMs in the OpenAI format\n\n{ui_message}", + f"Proxy Server to call 100+ LLMs in the OpenAI format. {custom_swagger_message}\n\n{ui_message}", ) if premium_user - else f"Proxy Server to call 100+ LLMs in the OpenAI format\n\n{ui_message}" + else f"Proxy Server to call 100+ LLMs in the OpenAI format. {custom_swagger_message}\n\n{ui_message}" ) app = FastAPI(