From d1cf41888b5487e5ebc41f4c3798784f377af84b Mon Sep 17 00:00:00 2001 From: ishaan-jaff Date: Thu, 14 Dec 2023 16:51:16 +0530 Subject: [PATCH] (feat) proxy add docstring for /test --- litellm/proxy/proxy_server.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/litellm/proxy/proxy_server.py b/litellm/proxy/proxy_server.py index 3b77d4d0109..9868a3e9874 100644 --- a/litellm/proxy/proxy_server.py +++ b/litellm/proxy/proxy_server.py @@ -1414,8 +1414,18 @@ async def config_yaml_endpoint(config_info: ConfigYAML): return {"hello": "world"} -@router.get("/test") +@router.get("/test", tags=["health"]) async def test_endpoint(request: Request): + """ + A test endpoint that pings the proxy server to check if it's healthy. + + Parameters: + request (Request): The incoming request. + + Returns: + dict: A dictionary containing the route of the request URL. + """ + # ping the proxy server to check if its healthy return {"route": request.url.path} @router.get("/health", tags=["health"], dependencies=[Depends(user_api_key_auth)])