›_ Codex Issues
Codex Issues / #13652

Config reference is behind config schema

Resolved 💬 3 comments Opened Mar 6, 2026 by alhllc Closed Mar 7, 2026
💡 Likely answer: A maintainer (github-actions[bot], contributor) responded on this thread — see the highlighted reply below.

Title
Config reference is behind config schema

What is the type of issue?

  • Documentation is incorrect
  • Documentation is missing

What is the issue?

  • target: https://developers.openai.com/codex/config-reference
  • compare against: https://developers.openai.com/codex/config-schema.json
  • (assumption: schema page comes from repo src at openai/codex/codex-rs/core/config.schema.json )
  • scope: entries below are incorrect or missing from config-reference

docs incorrect:

  1. setting: model_providers.<id>.wire_api

``md
{
key: "model_providers.<id>.wire_api",
type: "chat | responses",
description: "Protocol used by the provider (defaults to responses if omitted).",
},
``

  1. setting: model_reasoning_effort

``md
{
key: "model_reasoning_effort",
type: "none | minimal | low | medium | high | xhigh",
description: "See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning",
},
``

  1. setting: otel.exporter

``md
{
key: "otel.exporter",
type: "none | statsig | { otlp-http = { endpoint = string, protocol = binary | json, headers = map<string,string>, tls = object | null } } | { otlp-grpc = { endpoint = string, headers = map<string,string>, tls = object | null } }",
description: "Select the OpenTelemetry exporter and provide any endpoint metadata.",
},
``

  1. setting: otel.trace_exporter

``md
{
key: "otel.trace_exporter",
type: "none | statsig | { otlp-http = { endpoint = string, protocol = binary | json, headers = map<string,string>, tls = object | null } } | { otlp-grpc = { endpoint = string, headers = map<string,string>, tls = object | null } }",
description: "Select the OpenTelemetry trace exporter and provide any endpoint metadata.",
},
``

  1. setting: cli_auth_credentials_store

``md
{
key: "cli_auth_credentials_store",
type: "file | keyring | auto | ephemeral",
description: "Determine where Codex should store CLI auth credentials.",
},
``

docs missing:

  1. setting: otel.metrics_exporter

``md
{
key: "otel.metrics_exporter",
type: "none | statsig | { otlp-http = { endpoint = string, protocol = binary | json, headers = map<string,string>, tls = object | null } } | { otlp-grpc = { endpoint = string, headers = map<string,string>, tls = object | null } }",
description: "Optional metrics exporter",
},
``

  1. setting: audio

``md
{
key: "audio",
type: "table",
description: "Machine-local realtime audio device preferences used by realtime voice.",
},
``

  1. setting: commit_attribution

``md
{
key: "commit_attribution",
type: "string",
description: "Optional commit attribution text for commit message co-author trailers. Set to an empty string to disable automatic commit attribution.",
},
``

  1. setting: ghost_snapshot

``md
{
key: "ghost_snapshot",
type: "table",
description: "Settings for ghost snapshots (used for undo).",
},
``

  1. setting: js_repl_node_module_dirs

``md
{
key: "js_repl_node_module_dirs",
type: "array<string (path)>",
description: "Ordered list of directories to search for Node modules in js_repl.",
},
``

  1. setting: js_repl_node_path

``md
{
key: "js_repl_node_path",
type: "string (path)",
description: "Optional absolute path to the Node runtime used by js_repl.",
},
``

  1. setting: memories

``md
{
key: "memories",
type: "table",
description: "Memories subsystem settings.",
},
``

  1. setting: permissions

``md
{
key: "permissions",
type: "table",
description: "Nested permissions settings.",
},
``

  1. setting: plan_mode_reasoning_effort

``md
{
key: "plan_mode_reasoning_effort",
type: "none | minimal | low | medium | high | xhigh",
description: "Plan-mode-specific default reasoning effort override.",
},
``

  1. setting: plugins

``md
{
key: "plugins",
type: "table",
description: "User-level plugin config entries keyed by plugin name.",
},
``

  1. setting: service_tier

``md
{
key: "service_tier",
type: "fast | flex",
description: "Optional explicit service tier preference for new turns (fast or flex).",
},
``

  1. setting: zsh_path

``md
{
key: "zsh_path",
type: "string (path)",
description: "Optional absolute path to patched zsh used by zsh-exec-bridge-backed shell execution.",
},
``

Where did you find it?

  • https://developers.openai.com/codex/config-reference
  • https://developers.openai.com/codex/config-schema.json
  • related narrow issue: https://github.com/openai/codex/issues/13628

View original on GitHub ↗

3 Comments

github-actions[bot] contributor · 5 months ago

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

  • #13628
  • #12546

Powered by Codex Action

etraut-openai contributor · 5 months ago

Thanks for the bug report. Most of these omissions are intentional because they are features that are no longer supported are currently under development. We generally don't document features until they reach the "experimental" phase.

I update the documentation weekly.

etraut-openai contributor · 5 months ago

I just had Codex do a full pass and sync up the docs with the code. As I mentioned above, some keys are intentionally not yet documented because they correspond to features that are still under development.