Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

feat(docs): document `model_providers.<id>.capabilities` in the configuration reference

Aperta Adatta ai principianti
  • Qualcosa non va?
#52,255 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
75/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
rust
Ambito
documentation

Direzione di ricerca

Inizia dalle definizioni di ModelProviderCapabilities e RemoteCompactionSupport in codex-rs/core/config.schema.json, vicino alla riga 2731, e dal sorgente in codex-rs/model-provider-info/src/capabilities.rs, per confermare i nomi delle chiavi, i tipi, i valori consentiti e i valori predefiniti. Poi aggiungi le voci per model_providers.<id>.capabilities e le sue due chiavi nella pagina di riferimento della configurazione. È completato quando il TOML di esempio si carica con codex --strict-config alla versione 0.162.0 o successive.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

CLI config custom-model documentation

Documentation issue type

Documentation is missing

Where did you find it?

https://learn.chatgpt.com/docs/config-file/config-reference.md, the model_providers.<id>.* entries (lines 1028-1157 of the Markdown page).

Summary

codex-cli 0.162.0 added a [model_providers.<id>.capabilities] table for custom Responses-compatible providers (#50459). The table has two keys: external_web_access (boolean) and remote_compaction ("v2" or "unsupported"). The configuration reference lists 21 model_providers.<id>.* keys, including supports_standalone_web_search, but has no entry for this table or its keys. None of the 180 pages linked from the docs index at https://learn.chatgpt.com/llms.txt mentions external_web_access or remote_compaction.

Problem to solve

Users of a custom provider who want to stop hosted web search from reaching the live web, or who want local compaction instead of a provider compaction protocol, cannot find these settings in the reference. The PR description and codex-rs/core/config.schema.json are the only descriptions. The exact names matter. With --strict-config, a mistyped key inside the table is rejected. Without strict mode, the same typo is silently ignored and the provider keeps its default.

Proposed behavior

The configuration reference documents model_providers.<id>.capabilities and its two keys, with types, allowed values and defaults that match the shipped schema:

  • capabilities.external_web_access: boolean; whether hosted web search may access the live web.
  • capabilities.remote_compaction: v2 sends compaction_trigger items through the Responses endpoint; unsupported uses local compaction.
  • If either key is omitted, the provider keeps its existing default for that capability.

A short example could also go in Advanced Config next to the existing supports_standalone_web_search example. The sample config file could also gain one.

Acceptance criteria

  • The configuration reference has entries for model_providers.<id>.capabilities, model_providers.<id>.capabilities.external_web_access and model_providers.<id>.capabilities.remote_compaction. Their types and allowed values match the ModelProviderCapabilities and RemoteCompactionSupport definitions in codex-rs/core/config.schema.json.
  • Any documented example TOML for the table loads under codex --strict-config on 0.162.0 or later.

Affected area

Configuration reference page (custom model provider keys); optionally Advanced Config and the sample configuration page.

Non-goals

Changing the behavior or names of the capability keys.

Supporting context

  • Schema at tag rust-v0.162.0: codex-rs/core/config.schema.json (ModelProviderCapabilities near line 2731 with additionalProperties: false, and RemoteCompactionSupport). Source: codex-rs/model-provider-info/src/capabilities.rs.
  • Observed with codex-cli 0.162.0 on macOS arm64, using an isolated CODEX_HOME and no credentials. With --strict-config, the config below loaded and the run continued to the trusted-directory check. Replacing the two keys with not_a_key = true failed with exit status 1 and unknown configuration field `model_providers.custom.capabilities.not_a_key` . Without --strict-config, that typo config loaded with no warning and also reached the trusted-directory check.
[model_providers.custom]
name = "Custom"
base_url = "https://example.invalid/v1"

[model_providers.custom.capabilities]
external_web_access = false
remote_compaction = "unsupported"
  • Related open issues about remote compaction for custom providers: #42313 and #37010. Whether this table resolves either was not checked.
  • The GitHub release notes for 0.162.0 announce the feature in one line ("Configure live web access and remote compaction capabilities for custom Responses-compatible model providers.") but do not name the keys. Whether any page outside the llms.txt index documents them is unknown.

Triage assessment

  • Impact level: not-applicable
  • Assessment status: not-applicable
  • Impact basis: This is missing reference documentation for a new configuration surface. No existing documented behavior fails.
  • Workaround status: not-applicable
  • Workaround basis: No defect is involved. The keys work when they are configured from the PR description or the JSON schema.
Lingua principale
Rust
Stelle
130k
Fork
20.5k
Merge medio
1m
PR unite (30g)
996

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openai/codex

Tutte le issue di openai/codex

Issue simili

Altre issue su Rust

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.