Config reference is behind config schema
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:
- setting:
model_providers.<id>.wire_api
- config-reference line 523 - https://developers.openai.com/codex/config-reference.md
- should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L772
``mdresponses
{
key: "model_providers.<id>.wire_api",
type: "chat | responses",
description: "Protocol used by the provider (defaults to if omitted).",``
},
- setting:
model_reasoning_effort
- config-reference line 562 - https://developers.openai.com/codex/config-reference.md
- should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L2017
``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",
},
- setting:
otel.exporter
- config-reference line 726 - https://developers.openai.com/codex/config-reference.md
- should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L943
``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.",
},
- setting:
otel.trace_exporter
- config-reference line 732 - https://developers.openai.com/codex/config-reference.md
- should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L963
``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.",
},
- setting:
cli_auth_credentials_store
- config-reference line 873 - https://developers.openai.com/codex/config-reference.md
- should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1653
``md``
{
key: "cli_auth_credentials_store",
type: "file | keyring | auto | ephemeral",
description: "Determine where Codex should store CLI auth credentials.",
},
docs missing:
- setting:
otel.metrics_exporter
- missing:
otel.metrics_exporter - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L955
``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",
},
- setting:
audio
- missing:
audio - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1630
``md``
{
key: "audio",
type: "table",
description: "Machine-local realtime audio device preferences used by realtime voice.",
},
- setting:
commit_attribution
- missing:
commit_attribution - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1662
``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.",
},
- setting:
ghost_snapshot
- missing:
ghost_snapshot - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1891
``md``
{
key: "ghost_snapshot",
type: "table",
description: "Settings for ghost snapshots (used for undo).",
},
- setting:
js_repl_node_module_dirs
- missing:
js_repl_node_module_dirs - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1917
``mdjs_repl
{
key: "js_repl_node_module_dirs",
type: "array<string (path)>",
description: "Ordered list of directories to search for Node modules in .",``
},
- setting:
js_repl_node_path
- missing:
js_repl_node_path - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1924
``mdjs_repl
{
key: "js_repl_node_path",
type: "string (path)",
description: "Optional absolute path to the Node runtime used by .",``
},
- setting:
memories
- missing:
memories - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L1967
``md``
{
key: "memories",
type: "table",
description: "Memories subsystem settings.",
},
- setting:
permissions
- missing:
permissions - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L2063
``md``
{
key: "permissions",
type: "table",
description: "Nested permissions settings.",
},
- setting:
plan_mode_reasoning_effort
- missing:
plan_mode_reasoning_effort - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L2080
``md``
{
key: "plan_mode_reasoning_effort",
type: "none | minimal | low | medium | high | xhigh",
description: "Plan-mode-specific default reasoning effort override.",
},
- setting:
plugins
- missing:
plugins - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L2083
``md``
{
key: "plugins",
type: "table",
description: "User-level plugin config entries keyed by plugin name.",
},
- setting:
service_tier
- missing:
service_tier - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L2150
``mdfast
{
key: "service_tier",
type: "fast | flex",
description: "Optional explicit service tier preference for new turns ( or flex).",``
},
- setting:
zsh_path
- missing:
zsh_path - should be: https://github.com/openai/codex/blob/main/codex-rs/core/config.schema.json#L2240
``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-referencehttps://developers.openai.com/codex/config-schema.json- related narrow issue:
https://github.com/openai/codex/issues/13628
This issue has 3 comments on GitHub. Read the full discussion on GitHub ↗