clone/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-05-05 03:47:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

add generated jsonschema for config.toml (#8956)

Browse Source 
### What
Add JSON Schema generation for `config.toml`, with checked‑in
`docs/config.schema.json`. We can move the schema elsewhere if preferred
(and host it if there's demand).

Add fixture test to prevent drift and `just write-config-schema` to
regenerate on schema changes.

Generate MCP config schema from `RawMcpServerConfig` instead of
`McpServerConfig` because that is the runtime type used for
deserialization.

Populate feature flag values into generated schema so they can be
autocompleted.

### Tests
Added tests + regenerate script to prevent drift. Tested autocompletions
using generated jsonschema locally with Even Better TOML.



https://github.com/user-attachments/assets/5aa7cd39-520c-4a63-96fb-63798183d0bc
This commit is contained in:
sayan-oai
2026-01-13 10:22:51 -08:00
committed by GitHub
parent fe03320791
commit 40e2405998
20 changed files with 1757 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
codex-rs/core/src/config/schema.md Normal file
View File

@@ -0,0 +1,11 @@
# Config JSON Schema
We generate a JSON Schema for `~/.codex/config.toml` from the `ConfigToml` type
and commit it at `codex-rs/core/config.schema.json` for editor integration.
When you change any fields included in `ConfigToml` (or nested config types),
regenerate the schema:
```
just write-config-schema
```