Extend the Configuration Reference with the default values

Open 💬 2 comments Opened Feb 3, 2026 by SC-CTS

💡 Likely answer: A maintainer (github-actions[bot], contributor) responded on this thread — see the highlighted reply below.

What is the type of issue?

Documentation is missing

What is the issue?

The configuration reference only specifies the allowed values but is missing the default value used when not configured.

Where did you find it?

https://developers.openai.com/codex/config-reference

View original on GitHub ↗

2 Comments

github-actions[bot] contributor · 6 months ago

Potential duplicates detected. Please review them and close your issue if it is a duplicate.

#8702

Powered by Codex Action

middleDuckAi · 5 months ago

I reviewed this on current main, checked the duplicate pointer to #8702, and compared the actual runtime default with the repo-owned config reference surface.

Repro

The duplicate thread points to the docs site, but the in-repo config schema still says agents.max_threads has no limit when omitted.
On current main, runtime config resolution falls back to DEFAULT_AGENT_MAX_THREADS, which is Some(6).
That leaves a live mismatch between the effective default and the generated schema text shipped in the repo.

Root Cause

AgentsToml::max_threads still documents When unset, no limit is enforced. in codex-rs/core/src/config/mod.rs.
That doc comment feeds codex-rs/core/config.schema.json, so both source-of-truth and generated fixture drift together.
I kept the fix narrow to the exact setting that still misstates its default on current main.

Validation

cargo run -p codex-core --bin codex-write-config-schema
cargo test -p codex-core config_schema_matches_fixture -- --nocapture

Docs / Help Impact

Yes. The generated config schema now says When unset, Codex defaults this limit to 6. for agents.max_threads.

Risk

Low. This is a docs/schema-only correction for one field, with the generated fixture re-synced and the schema fixture test passing.

Maintainer Pickup

gh pr create --repo openai/codex --base main --head middleDuckAi:middleDuck/codex-10517-extend-the-configuration-reference-with-the --title "$(gh pr view 9 --repo middleDuckAi/codex --json title --jq .title)" --body "$(gh pr view 9 --repo middleDuckAi/codex --json body --jq .body)"