diff --git a/docs/my-website/docs/proxy/config_settings.md b/docs/my-website/docs/proxy/config_settings.md index 8b4514f568..53b0f3eea7 100644 --- a/docs/my-website/docs/proxy/config_settings.md +++ b/docs/my-website/docs/proxy/config_settings.md @@ -449,6 +449,13 @@ router_settings: | BRAINTRUST_API_KEY | API key for Braintrust integration | BRAINTRUST_API_BASE | Base URL for Braintrust API. Default is https://api.braintrustdata.com/v1 | CACHED_STREAMING_CHUNK_DELAY | Delay in seconds for cached streaming chunks. Default is 0.02 +| CHATGPT_API_BASE | Base URL for ChatGPT API. Default is https://chatgpt.com/backend-api/codex +| CHATGPT_AUTH_FILE | Filename for ChatGPT authentication data. Default is "auth.json" +| CHATGPT_DEFAULT_INSTRUCTIONS | Default system instructions for ChatGPT provider +| CHATGPT_ORIGINATOR | Originator identifier for ChatGPT API requests. Default is "codex_cli_rs" +| CHATGPT_TOKEN_DIR | Directory to store ChatGPT authentication tokens. Default is "~/.config/litellm/chatgpt" +| CHATGPT_USER_AGENT | Custom user agent string for ChatGPT API requests +| CHATGPT_USER_AGENT_SUFFIX | Suffix to append to the ChatGPT user agent string | CIRCLE_OIDC_TOKEN | OpenID Connect token for CircleCI | CIRCLE_OIDC_TOKEN_V2 | Version 2 of the OpenID Connect token for CircleCI | CLOUDZERO_API_KEY | CloudZero API key for authentication @@ -794,6 +801,7 @@ router_settings: | OPENAI_BASE_URL | Base URL for OpenAI API | OPENAI_API_BASE | Base URL for OpenAI API. Default is https://api.openai.com/ | OPENAI_API_KEY | API key for OpenAI services +| OPENAI_CHATGPT_API_BASE | Alternative to CHATGPT_API_BASE. Base URL for ChatGPT API | OPENAI_FILE_SEARCH_COST_PER_1K_CALLS | Cost per 1000 calls for OpenAI file search. Default is 0.0025 | OPENAI_ORGANIZATION | Organization identifier for OpenAI | OPENID_BASE_URL | Base URL for OpenID Connect services diff --git a/tests/documentation_tests/test_env_keys.py b/tests/documentation_tests/test_env_keys.py index 6b7c15e2b9..4fed84d043 100644 --- a/tests/documentation_tests/test_env_keys.py +++ b/tests/documentation_tests/test_env_keys.py @@ -16,6 +16,25 @@ get_secret_str_pattern = re.compile( # Set to store unique keys from the code env_keys = set() +# Terminal/environment detection variables that should not be documented +# These are internal variables used for terminal detection, not user-configurable settings +EXCLUDED_TERMINAL_VARS = { + "TERM", + "TERM_PROGRAM", + "TERM_PROGRAM_VERSION", + "TERM_SESSION_ID", + "VTE_VERSION", + "KITTY_WINDOW_ID", + "KONSOLE_VERSION", + "ITERM_PROFILE", + "ITERM_PROFILE_NAME", + "ITERM_SESSION_ID", + "WEZTERM_VERSION", + "WT_SESSION", + "GNOME_TERMINAL_SCREEN", + "ALACRITTY_SOCKET", +} + # Walk through all files in the litellm repo to find references of os.getenv() and litellm.get_secret() for root, dirs, files in os.walk(repo_base): for file in files: @@ -28,7 +47,8 @@ for root, dirs, files in os.walk(repo_base): getenv_matches = getenv_pattern.findall(content) env_keys.update( match for match in getenv_matches - ) # Extract only the key part + if match not in EXCLUDED_TERMINAL_VARS + ) # Extract only the key part, excluding terminal vars # Find all keys using litellm.get_secret() get_secret_matches = get_secret_pattern.findall(content)