Skip to content

armgit / codex

Public Imported from GitHub
0

Lightweight coding agent that runs in your terminal

Rust

Correct provider authentication storage documentation (#49118)

Celia Chen6c4924056590
diff --git a/codex-rs/core/config.schema.json b/codex-rs/core/config.schema.json
index 0aca017176..ac6171c01c 100644
--- a/codex-rs/core/config.schema.json
+++ b/codex-rs/core/config.schema.json
@@ -2714,7 +2714,7 @@
},
"requires_openai_auth": {
"default": false,
- "description": "Does this provider require an OpenAI API Key or ChatGPT login token? If true, user is presented with login screen on first run, and login preference and token/key are stored in auth.json. If false (which is the default), login screen is skipped, and API key (if needed) comes from the \"env_key\" environment variable.",
+ "description": "Does this provider require an OpenAI API key or ChatGPT login token? If true, the user is presented with a login screen on first run, and credentials are stored using the backend selected by `cli_auth_credentials_store`. If false (the default), the login screen is skipped, and the API key (if needed) comes from the environment variable specified by `env_key`.",
"type": "boolean"
},
"stream_idle_timeout_ms": {
diff --git a/codex-rs/model-provider-info/src/lib.rs b/codex-rs/model-provider-info/src/lib.rs
index c18ce6c322..ffb84ef12e 100644
--- a/codex-rs/model-provider-info/src/lib.rs
+++ b/codex-rs/model-provider-info/src/lib.rs
@@ -180,10 +180,11 @@ pub struct ModelProviderInfo {
/// Maximum time (in milliseconds) to wait for a websocket connection attempt before treating
/// it as failed.
pub websocket_connect_timeout_ms: Option<u64>,
- /// Does this provider require an OpenAI API Key or ChatGPT login token? If true,
- /// user is presented with login screen on first run, and login preference and token/key
- /// are stored in auth.json. If false (which is the default), login screen is skipped,
- /// and API key (if needed) comes from the "env_key" environment variable.
+ /// Does this provider require an OpenAI API key or ChatGPT login token? If true,
+ /// the user is presented with a login screen on first run, and credentials are
+ /// stored using the backend selected by `cli_auth_credentials_store`.
+ /// If false (the default), the login screen is skipped, and the API key
+ /// (if needed) comes from the environment variable specified by `env_key`.
#[serde(default)]
pub requires_openai_auth: bool,
/// Whether this provider supports the Responses API WebSocket transport.