docs: expose response schema, cache and provider_options; add vendor schema gap analysis#13
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3fbb9cf0d4
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | `sampling` | `object` | `{ temperature, top_p, frequency_penalty, presence_penalty, stop, max_output_tokens }` | | ||
| | `response` | `object` | `{ format, stream }` | | ||
| | `response` | `object` | `{ format, stream, schema, schema_name, schema_strict }` | | ||
| | `cache` | `object` | Provider-specific cache controls (`openai`, `anthropic`, `gemini`/`google`) | |
There was a problem hiding this comment.
Stop documenting cache as an overridable field
This change adds cache to the overridable fields and says it is shallow-merged, but override application currently ignores it: mergeOverride in src/overrides/apply-overrides.ts has no override.cache handling, so environment/tier/runtime cache values never take effect. Users following this doc will believe cache strategy can be overridden when it is silently ignored at render time.
Useful? React with 👍 / 👎.
| Supported default fields: | ||
| - `provider` (front matter) — default provider for the folder | ||
| - `model` (front matter) — default model for the folder | ||
| - `cache` (front matter) — default provider-specific cache hints |
There was a problem hiding this comment.
Remove defaults cache guidance until it is implemented
This new bullet says defaults.md supports cache, but defaults loading does not merge or apply cache settings (src/parser/loader.ts only merges provider/model/metadata/sections in mergeDefaults/applyDefaults). That means prompt trees configured per this guidance will silently lose default cache config, which is a behavior mismatch users cannot detect from the docs alone.
Useful? React with 👍 / 👎.
Motivation
openai-responsesand document how overrides and defaults interact with the new fields.Description
response.schema,response.schema_name, andresponse.schema_strictto the front-matter schema and examples acrossREADME.md,SKILL.md, anddocs/schema.md.cacheblock and documented provider-specific cache controls inREADME.md,SKILL.md,docs/schema.md,docs/overrides.md, and defaults guidance.provider_optionsfor non-portable vendor-specific settings (examples foranthropicandgemini) and surfaced it in overrides and schema docs.openai-responsesin provider enumerations and updated overridable-fields and shallow-merge semantics to includecacheandprovider_options.docs/vendor-schema-gap-analysis.mdfile summarizing current vendor capabilities, gaps, and recommended next steps.docs/index.mdto link to the new vendor schema gap analysis.Testing
npm run docs:buildand ran markdown linting (npm run lint:md) and both completed successfully.Codex Task