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>
292 lines
9.5 KiB
JSON
292 lines
9.5 KiB
JSON
{
|
|
"$id": "https://coursebank.dev/schema/assessment.schema.json",
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"additionalProperties": false,
|
|
"description": "A record of what was given, to whom, and when. This is the join between item banks and grading data, and it is the source of truth for reuse history — there is no separate ledger to drift out of step.",
|
|
"properties": {
|
|
"assessment": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"attempts": {
|
|
"description": "Canvas attempt limit; -1 for unlimited.",
|
|
"type": "integer"
|
|
},
|
|
"date": {
|
|
"description": "Administration date. Drives reuse cooldowns.",
|
|
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
|
|
"type": "string"
|
|
},
|
|
"id": {
|
|
"description": "Assessment id, e.g. exam-4. Used in administration ids.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"instructions": {
|
|
"type": "string"
|
|
},
|
|
"kind": {
|
|
"description": "practice is excluded from calibration by default, since conditions differ too much to pool.",
|
|
"enum": [
|
|
"exam",
|
|
"quiz",
|
|
"homework",
|
|
"practice",
|
|
"final"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"minutes_allowed": {
|
|
"exclusiveMinimum": 0.0,
|
|
"type": "number"
|
|
},
|
|
"notes": {
|
|
"type": "string"
|
|
},
|
|
"platform": {
|
|
"enum": [
|
|
"paper",
|
|
"canvas",
|
|
"other"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"scoring_policy": {
|
|
"enum": [
|
|
"keep_highest",
|
|
"keep_latest"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"shuffle": {
|
|
"type": "boolean"
|
|
},
|
|
"term": {
|
|
"description": "Defaults to the course term.",
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"description": "Printed title.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"title"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"blueprint": {
|
|
"additionalProperties": false,
|
|
"description": "The design the form was drawn to satisfy. Kept so the form can be checked against the intent afterward.",
|
|
"properties": {
|
|
"banks": {
|
|
"description": "Restrict the draw to these banks.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"bonus_counts": {
|
|
"additionalProperties": {
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"type": "object"
|
|
},
|
|
"cooldown_days": {
|
|
"description": "Avoid items used within this many days. Relaxed with a warning rather than failing the draw.",
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"lectures": {
|
|
"description": "Restrict the draw to these lectures.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"level_counts": {
|
|
"additionalProperties": {
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"description": "How many scored items at each level, keyed by level number.",
|
|
"type": "object"
|
|
},
|
|
"max_per_bank": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
"objective_minimums": {
|
|
"additionalProperties": {
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"description": "Minimum items per objective. Placed before level quotas, because a coverage requirement is the constraint most likely to become unsatisfiable. A requirement is satisfied by items on any of that objective's targets, so this stays short: name the dozen objectives the exam is meant to cover, not the hundred targets it is built from.",
|
|
"type": "object"
|
|
},
|
|
"seed": {
|
|
"description": "Makes the draw reproducible.",
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"topics": {
|
|
"description": "Restrict the draw to these topics.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"forms": {
|
|
"description": "Alternate forms. Option order is derived from the seed rather than stored, so every export of a form agrees.",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"id": {
|
|
"description": "Form label, e.g. A.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"seed": {
|
|
"minimum": 0,
|
|
"type": "integer"
|
|
},
|
|
"shuffle_items": {
|
|
"type": "boolean"
|
|
},
|
|
"shuffle_options": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"required": [
|
|
"id",
|
|
"seed"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"items": {
|
|
"description": "One entry per question, in number order.",
|
|
"items": {
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"bonus": {
|
|
"type": "boolean"
|
|
},
|
|
"credit_overrides": {
|
|
"additionalProperties": {
|
|
"maximum": 1.0,
|
|
"minimum": 0.0,
|
|
"type": "number"
|
|
},
|
|
"description": "Partial credit decided after the fact, by option letter. Recording it here keeps the rescoring decision with the administration it applies to.",
|
|
"type": "object"
|
|
},
|
|
"distractors": {
|
|
"description": "The option ids offered alongside the key. Resolved when the assessment is assembled and written out explicitly, so a later bank edit cannot change the paper. Empty means the whole pool.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"dropped": {
|
|
"description": "Thrown out after the exam. Always excluded from statistics; dropped_as says whether it stays in the score.",
|
|
"type": "boolean"
|
|
},
|
|
"dropped_as": {
|
|
"description": "How a dropped question was handled on the grading platform. removed, the default, takes it out of the numerator and the denominator. full_credit keeps it in both: use it when everyone was given the points, so reports agree with the platform's grade.",
|
|
"enum": [
|
|
"removed",
|
|
"full_credit"
|
|
],
|
|
"type": "string"
|
|
},
|
|
"dropped_before_printing": {
|
|
"description": "Pulled before the paper was printed, so it never held a position and later questions moved up. Leave unset for a question thrown out after the exam: setting it wrongly attributes responses to the wrong items.",
|
|
"type": "boolean"
|
|
},
|
|
"fingerprint": {
|
|
"description": "What the item looked like when given. Validation warns if the item has since changed.",
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"description": "Item reference, `bank::item-id` or a bare item id.",
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"key": {
|
|
"description": "The option ids keyed correct for this administration. One for a single_best_answer, chosen from the item's pool of defensible keys.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"learning_objectives": {
|
|
"description": "The older name for learning_targets.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"learning_targets": {
|
|
"description": "Targets as administered.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"level": {
|
|
"description": "Cognitive level. 1 = Remember (recalling terms, facts, and definitions); 2 = Understand (explaining ideas in your own words); 3 = Apply (using a procedure in a new situation); 4 = Analyze (taking a situation apart and relating the pieces); 5 = Evaluate/Create (judging alternatives or building something new)",
|
|
"maximum": 5,
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
"number": {
|
|
"description": "The question number as administered. This is the join key to Gradescope and Canvas exports, so it must not change after the fact.",
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
},
|
|
"points": {
|
|
"minimum": 0.0,
|
|
"type": "number"
|
|
},
|
|
"stem_digest": {
|
|
"description": "The stem as given. Validation treats a change as an error, since it is no longer the same question.",
|
|
"type": "string"
|
|
},
|
|
"variant": {
|
|
"description": "Digest of the item as this administration showed it: stem, administered options, and which was keyed. The key statistics pool on.",
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"minimum": 1,
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"required": [
|
|
"number",
|
|
"item"
|
|
],
|
|
"type": "object"
|
|
},
|
|
"type": "array"
|
|
},
|
|
"schema_version": {
|
|
"type": [
|
|
"string",
|
|
"number"
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"assessment"
|
|
],
|
|
"title": "coursebank assessment record",
|
|
"type": "object"
|
|
}
|