mirror of
https://github.com/dtzp555-max/ocp.git
synced 2026-07-27 07:55:07 +00:00
Both review findings taken. MED — the schema declared `$schema: draft/2020-12`, which promises full draft semantics, while the validator that actually runs it enforces only a subset. Someone adding `"minimum": 1` to contextWindow would get SILENT no-op with a green suite — a trap made worse by the file looking authoritative. The description now enumerates exactly what is enforced (type, required, const, enum, additionalProperties in both forms, items, minItems/maxItems, anyOf/allOf/oneOf, $ref, nullable) and names what is ignored (minimum, maxLength, pattern, uniqueItems, propertyNames, not), with the instruction to add such a constraint as a test instead. LOW — three corruptions neither the schema nor any sibling test caught: duplicate models[].id, empty-string id/displayName/openclawName, and non-positive contextWindow/maxTokens. They are structurally NOT expressible with the supported keyword set (no uniqueItems, no minLength, no minimum), so they are asserted directly rather than by pretending the schema covers them. Mutation-proven, all three previously slipped through: duplicate id -> CAUGHT empty displayName -> CAUGHT zero contextWindow -> CAUGHT Tests: 461 passed, 0 failed (460 + 1). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017gbqUZ8HfBZpjjbzQ85oH8
66 lines
3.8 KiB
JSON
66 lines
3.8 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://github.com/dtzp555-max/ocp/blob/main/models.schema.json",
|
|
"title": "OCP models.json",
|
|
"description": "Schema for models.json, the single source of truth for model metadata (ADR 0003). Enforced in CI by test-features.mjs, which validates models.json against this file using the repo's own validateJsonSchema (lib/structured-output.mjs) — no new dependency. ⚠ ONLY A SUBSET OF DRAFT 2020-12 IS ENFORCED: type, required, const, enum, additionalProperties (boolean and schema forms), items, minItems, maxItems, anyOf/allOf/oneOf, $ref, nullable. Anything else — minimum, maxLength, pattern, uniqueItems, propertyNames, not — is SILENTLY IGNORED by that validator, so adding one here buys nothing and misleads the next reader. Add such a constraint as a test in test-features.mjs instead. NOTE: referential integrity (every aliases/legacyAliases target must exist as a models[].id) is likewise not expressible here and is covered by separate tests.",
|
|
"type": "object",
|
|
"required": ["version", "models", "aliases", "legacyAliases"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"$schema": {
|
|
"type": "string",
|
|
"description": "Relative path to this file. Editors use it for completion; CI does not read it."
|
|
},
|
|
"version": {
|
|
"const": 1,
|
|
"description": "Schema version of this document. Bump only alongside a shape change and an ADR."
|
|
},
|
|
"models": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"description": "Every model OCP advertises on /v1/models, newest first. Order is load-bearing: ocp-connect uses model_ids[0] as a primary fallback.",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["id", "displayName", "openclawName", "reasoning", "contextWindow", "maxTokens"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Canonical CLI model id, passed verbatim to `claude --model`. Must match the id in the compiled CLI registry."
|
|
},
|
|
"displayName": {
|
|
"type": "string",
|
|
"description": "Human label. Also used as the OpenClaw agent alias by scripts/sync-openclaw.mjs."
|
|
},
|
|
"openclawName": {
|
|
"type": "string",
|
|
"description": "Label written into OpenClaw's model registry."
|
|
},
|
|
"reasoning": {
|
|
"type": "boolean",
|
|
"description": "Whether OpenClaw should treat the model as reasoning-capable."
|
|
},
|
|
"contextWindow": {
|
|
"type": "integer",
|
|
"description": "Advertised context window. GLOBAL side effect: MAX_PROMPT_CHARS derives from max(contextWindow) x 3 across ALL entries (lib/prompt.mjs derivePromptCharBudget), so raising this on ONE model raises the truncation ceiling for EVERY model. See ADR 0009. Also feeds OpenClaw's compaction budget."
|
|
},
|
|
"maxTokens": {
|
|
"type": "integer",
|
|
"description": "Advertised output cap. OCP does not enforce it; it is propagated to OpenClaw (via setup.mjs / scripts/sync-openclaw.mjs) where it bounds request and compaction budgets."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"aliases": {
|
|
"type": "object",
|
|
"description": "Short name -> canonical models[].id. Client-addressable, so a repoint changes routing for every request using the alias. Cache keys resolve these before hashing (server.mjs cacheModel).",
|
|
"additionalProperties": { "type": "string" }
|
|
},
|
|
"legacyAliases": {
|
|
"type": "object",
|
|
"description": "Retired ids kept resolvable for backward compatibility -> canonical models[].id. Also client-addressable and also resolved in cache keys.",
|
|
"additionalProperties": { "type": "string" }
|
|
}
|
|
}
|
|
}
|