feat(schema): 2.1 types, fragments, and JSON Schemas
Add the term, equation, value, and misconception registries (src/model/course/glossary.rs) and the new optional fields on objectives, targets, lectures, readings, bank options, and policy. Load registry entries from objective files, glossary.yaml, and course.yaml, with one definition site per id as for every other registry. Port every edit in docs/design/2.1/build_schemas.py into the hand-written schema builders, add glossary.schema.json, and test the generated schemas against the targets; the only differences are two 2.0 spellings the code already had. The 2.0 example fragments load and validate unchanged. The 2.1 example bank gains `status: draft`, which every coursebank item requires. tests/docs.rs skips docs/design/, which holds design records rather than guide pages. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
47 files changed
+10568
-55
No files matched your search
@@ -0,0 +1,358 @@
|
||||
{
|
||||
"$id": "https://coursebank.dev/schema/calibration.schema.json",
|
||||
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
||||
"additionalProperties": false,
|
||||
"description": "The pooled statistics, by item id. Kept out of the banks: a bank's diff should be a change of intent, not the output of a grading run. Committed — every number here is a cohort aggregate, and there is no field for a student.",
|
||||
"properties": {
|
||||
"items": {
|
||||
"additionalProperties": {
|
||||
"additionalProperties": false,
|
||||
"description": "Written by `coursebank calibrate`, not by hand. Pooled across administrations.",
|
||||
"properties": {
|
||||
"administrations": {
|
||||
"description": "Administration ids pooled here.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"discrimination_index": {
|
||||
"maximum": 1.0,
|
||||
"minimum": -1.0,
|
||||
"type": "number"
|
||||
},
|
||||
"fingerprint": {
|
||||
"description": "Hash of what a student saw. When it stops matching the item, these statistics describe a different question.",
|
||||
"type": "string"
|
||||
},
|
||||
"flags": {
|
||||
"items": {
|
||||
"enum": [
|
||||
"negative_discrimination",
|
||||
"low_discrimination",
|
||||
"distractor_outperforms_key",
|
||||
"key_underperforms",
|
||||
"too_easy",
|
||||
"too_hard",
|
||||
"high_rapid_guess",
|
||||
"nonfunctioning_distractor",
|
||||
"dif_flagged",
|
||||
"ambiguous",
|
||||
"design_mismatch"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"irt": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"a": {
|
||||
"description": "Discrimination.",
|
||||
"type": "number"
|
||||
},
|
||||
"b": {
|
||||
"description": "Difficulty.",
|
||||
"type": "number"
|
||||
},
|
||||
"bayesian": {
|
||||
"description": "Whether priors were used. On a class-sized sample they should be.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"c": {
|
||||
"description": "Lower asymptote, 3PL only.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"model": {
|
||||
"enum": [
|
||||
"rasch",
|
||||
"2pl",
|
||||
"3pl"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"n": {
|
||||
"minimum": 0,
|
||||
"type": "integer"
|
||||
},
|
||||
"se_a": {
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"se_b": {
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"a",
|
||||
"b"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"mean_response_time_seconds": {
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"n_examinees": {
|
||||
"minimum": 0,
|
||||
"type": "integer"
|
||||
},
|
||||
"option_stats": {
|
||||
"additionalProperties": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"lower_group_rate": {
|
||||
"description": "Rate in the bottom 27%.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"point_biserial": {
|
||||
"maximum": 1.0,
|
||||
"minimum": -1.0,
|
||||
"type": "number"
|
||||
},
|
||||
"selection_rate": {
|
||||
"description": "How often chosen.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"upper_group_rate": {
|
||||
"description": "Rate in the top 27%.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"options": {
|
||||
"additionalProperties": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"appearances": {
|
||||
"minimum": 0,
|
||||
"type": "integer"
|
||||
},
|
||||
"mean_selection_rate": {
|
||||
"description": "Mean of the within-variant rates. For reading, not for acting on: each rate is a share of a different set.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"n_examinees": {
|
||||
"minimum": 0,
|
||||
"type": "integer"
|
||||
},
|
||||
"never_chosen": {
|
||||
"description": "Never chosen, anywhere. The claim that justifies retiring it.",
|
||||
"type": "boolean"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"description": "One record per option, pooled across every set it appeared in. Supports one claim — this option draws nobody, anywhere — which is what retires a distractor and what one administration cannot show.",
|
||||
"type": "object"
|
||||
},
|
||||
"p_value": {
|
||||
"description": "Observed proportion correct.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"point_biserial": {
|
||||
"maximum": 1.0,
|
||||
"minimum": -1.0,
|
||||
"type": "number"
|
||||
},
|
||||
"rapid_guess_rate": {
|
||||
"description": "Fraction answered faster than readable.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"updated": {
|
||||
"description": "When calibration last ran.",
|
||||
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
|
||||
"type": "string"
|
||||
},
|
||||
"variants": {
|
||||
"description": "One record per option set ever administered. A stem shown with different distractors is a different item, so a p-value pooled across both would average two questions.",
|
||||
"items": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"administrations": {
|
||||
"description": "The administrations pooled into these numbers.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"discrimination_index": {
|
||||
"maximum": 1.0,
|
||||
"minimum": -1.0,
|
||||
"type": "number"
|
||||
},
|
||||
"distractors": {
|
||||
"description": "The option ids offered alongside them.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"flags": {
|
||||
"items": {
|
||||
"enum": [
|
||||
"negative_discrimination",
|
||||
"low_discrimination",
|
||||
"distractor_outperforms_key",
|
||||
"key_underperforms",
|
||||
"too_easy",
|
||||
"too_hard",
|
||||
"high_rapid_guess",
|
||||
"nonfunctioning_distractor",
|
||||
"dif_flagged",
|
||||
"ambiguous",
|
||||
"design_mismatch"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"irt": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"a": {
|
||||
"description": "Discrimination.",
|
||||
"type": "number"
|
||||
},
|
||||
"b": {
|
||||
"description": "Difficulty.",
|
||||
"type": "number"
|
||||
},
|
||||
"bayesian": {
|
||||
"description": "Whether priors were used. On a class-sized sample they should be.",
|
||||
"type": "boolean"
|
||||
},
|
||||
"c": {
|
||||
"description": "Lower asymptote, 3PL only.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"model": {
|
||||
"enum": [
|
||||
"rasch",
|
||||
"2pl",
|
||||
"3pl"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
"n": {
|
||||
"minimum": 0,
|
||||
"type": "integer"
|
||||
},
|
||||
"se_a": {
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"se_b": {
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"a",
|
||||
"b"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"key": {
|
||||
"description": "The option ids keyed correct in this set.",
|
||||
"items": {
|
||||
"type": "string"
|
||||
},
|
||||
"type": "array"
|
||||
},
|
||||
"n_examinees": {
|
||||
"minimum": 0,
|
||||
"type": "integer"
|
||||
},
|
||||
"option_stats": {
|
||||
"additionalProperties": {
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"lower_group_rate": {
|
||||
"description": "Rate in the bottom 27%.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"point_biserial": {
|
||||
"maximum": 1.0,
|
||||
"minimum": -1.0,
|
||||
"type": "number"
|
||||
},
|
||||
"selection_rate": {
|
||||
"description": "How often chosen.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"upper_group_rate": {
|
||||
"description": "Rate in the top 27%.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"description": "Per-option behavior within this set, by option id.",
|
||||
"type": "object"
|
||||
},
|
||||
"p_value": {
|
||||
"description": "Proportion correct, for this option set only.",
|
||||
"maximum": 1.0,
|
||||
"minimum": 0.0,
|
||||
"type": "number"
|
||||
},
|
||||
"point_biserial": {
|
||||
"maximum": 1.0,
|
||||
"minimum": -1.0,
|
||||
"type": "number"
|
||||
},
|
||||
"variant": {
|
||||
"description": "Digest of the stem, the administered options, and which was keyed.",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"variant"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"type": "array"
|
||||
}
|
||||
},
|
||||
"type": "object"
|
||||
},
|
||||
"description": "Keyed by item id, which since 2.0 names the item course-wide and carries no file name, so moving a question between banks does not orphan its statistics.",
|
||||
"type": "object"
|
||||
},
|
||||
"schema_version": {
|
||||
"type": [
|
||||
"string",
|
||||
"number"
|
||||
]
|
||||
}
|
||||
},
|
||||
"title": "coursebank calibration store",
|
||||
"type": "object"
|
||||
}
|
||||
Reference in new issue
Block a user