Files
paperspec/schemas/annotation.schema.json
T
alexmandClaude a09d158e16 feat: minted keys, VRF seeds, RFC 9162 proofs, history roots, tag URIs and a transparency log
Keys (spec/02 §2.4), the rule paperstack settled on:
- A work key is a Scholar-style citation key, a hyphen and the first four
  Crockford base32 characters of SHA-256("scienting-key/1:" + identity),
  where the identity is the first of doi, arxiv, isbn, pmid, pmcid and
  openalex in same_as, else the folded title, year and family name. A
  collision lengthens the later key by two characters; a key is minted
  once and never recomputed. A document key adds .si, .v<seq> or .<type>
  for versions other than the version of record.
- Every fixture key is now minted (hale2026harmonic-damb,
  okafor2025solvent-acth, writer2027fixed-ynr7.v3, tiny2026tiny-j4qm), so
  every node and record ID was re-minted and the docs rewritten to match.
  The validator checks the document key against the work key and version
  (doc.key.work) and the hash part against the identifier (doc.key.suffix).
  vectors/keys.jsonl pins the cases paperstack's tests pin.

Review:
- Spot-check seeds are ECVRF-EDWARDS25519-SHA512-TAI proofs (RFC 9381),
  implemented in tools/oracle/vrf.py in plain Python and reproduced
  against the RFC's Example 16; the sample ranks by the VRF output. The
  earlier Ed25519 seed could be ground by a dishonest checker.
- RFC 9162 inclusion and consistency proofs (crypto.inclusion_path,
  verify_inclusion, consistency_proof, verify_consistency) with
  scienting-proof/1, vectors/proofs.jsonl and two fixture records.
- document.json carries `history`, the root over the corrections, with
  the empty-tree hash for none (spec/11 §11.5, rule doc.history).
- A provisional transparency log (spec/23): log entries, signed-note
  checkpoints with key hashes as transparency logs share them, the rule
  that a logged revocation beats a self-asserted time, and vectors.
- Reserved signature schemes cose and ml-dsa-65 (spec/08 §8.4).

Identifiers and text:
- urn:scienting: becomes tag:scient.ing,2026: (RFC 4151), since the URN
  namespace was never registered.
- Unicode 16.0 is pinned for normalization and categories (spec/01 §1.4);
  the checker refuses another version.

Checking:
- check.py: keys, proofs, VRF and checkpoint vectors; the proof and
  checkpoint records; a check that every ID and hash the prose quotes
  exists in the fixtures or vectors; three more broken packages
  (history-wrong, key-suffix, key-work).
- stress.py: key, VRF, proof and checkpoint properties.
- Docs: a keys section in the concepts and FAQ, rationale entries for
  keys, VRF, proofs, tag URIs and the Unicode pin, a "Looking ahead"
  section, media-type registration and OCI distribution notes.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2026-10-14 23:21:57 -04:00

745 lines
19 KiB
JSON

{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://paperspec.scient.ing/schemas/annotation.schema.json",
"title": "Annotation",
"description": "One line of annotations.jsonl in scienting-layer/1: a W3C Web Annotation; spec/18-layers.md.",
"type": "object",
"properties": {
"@context": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"minItems": 2
},
"id": {
"type": "string",
"pattern": "^tag:scient\\.ing,2026:annotation:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
},
"type": {
"const": "Annotation"
},
"layer": {
"type": "string",
"pattern": "^tag:scient\\.ing,2026:layer:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
},
"motivation": {
"enum": [
"commenting",
"describing",
"linking",
"questioning",
"assessing",
"tagging",
"classifying",
"identifying",
"editing",
"highlighting",
"bookmarking",
"replying",
"moderating"
]
},
"creator": {
"$ref": "common.schema.json#/$defs/agent"
},
"created": {
"$ref": "common.schema.json#/$defs/time"
},
"modified": {
"$ref": "common.schema.json#/$defs/time"
},
"body": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "gloss"
},
"audience": {
"enum": [
"novice",
"student",
"expert"
]
}
},
"required": [
"type",
"kind",
"value",
"audience"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"minLength": 1
},
"kind": {
"const": "claim-link"
},
"pin": {
"type": "string",
"minLength": 1
},
"role": {
"enum": [
"states",
"uses",
"disputes"
]
}
},
"required": [
"type",
"kind",
"source",
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"minLength": 1
},
"kind": {
"const": "symbol"
},
"pin": {
"type": "string",
"minLength": 1
},
"symbol": {
"type": "string",
"minLength": 1
}
},
"required": [
"type",
"kind",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "comment"
}
},
"required": [
"type",
"kind",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "caveat"
}
},
"required": [
"type",
"kind",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "question"
},
"for": {
"enum": [
"reader",
"group",
"authors"
]
}
},
"required": [
"type",
"kind",
"value"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "exercise"
},
"exercise": {
"$ref": "exercise.schema.json"
}
},
"required": [
"type",
"kind",
"value",
"exercise"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "citation-context"
},
"reference": {
"$ref": "common.schema.json#/$defs/nodeId"
},
"verdict": {
"enum": [
"supports",
"partly",
"does-not",
"cannot-tell"
]
},
"reason": {
"enum": [
"method",
"value",
"background",
"contrast",
"other"
]
}
},
"required": [
"type",
"kind",
"value",
"reference"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"minLength": 1
},
"kind": {
"const": "prerequisite"
}
},
"required": [
"type",
"kind",
"source"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"minLength": 1
},
"kind": {
"const": "crosslink"
},
"selector": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"const": "AnchorSelector"
},
"anchor": {
"$ref": "anchor.schema.json"
}
},
"required": [
"type",
"anchor"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"type",
"kind",
"source",
"selector"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "translation"
}
},
"required": [
"type",
"kind",
"value",
"language"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "description"
},
"role": {
"enum": [
"alt",
"long"
]
}
},
"required": [
"type",
"kind",
"value",
"role"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextualBody"
},
"value": {
"type": "string",
"minLength": 1
},
"format": {
"enum": [
"text/plain",
"text/markdown"
]
},
"language": {
"$ref": "common.schema.json#/$defs/language"
},
"kind": {
"const": "generated"
},
"generator": {
"type": "object",
"properties": {
"model": {
"type": "string",
"minLength": 1
},
"run": {
"type": "string",
"minLength": 1
}
},
"required": [
"model",
"run"
],
"additionalProperties": false
}
},
"required": [
"type",
"kind",
"value",
"generator"
],
"additionalProperties": false
}
]
},
"target": {
"oneOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"pattern": "^tag:scient\\.ing,2026:doc:[a-z0-9][a-z0-9._-]*/[a-z][a-z0-9]*-[0-9a-hjkmnp-tv-z]{4,51}(\\.[a-z0-9][a-z0-9-]*)*$"
},
"selector": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "AnchorSelector"
},
"anchor": {
"$ref": "anchor.schema.json"
}
},
"required": [
"type",
"anchor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextQuoteSelector"
},
"exact": {
"type": "string",
"minLength": 1
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"required": [
"type",
"exact"
],
"additionalProperties": false
}
]
},
"minItems": 1
}
},
"required": [
"type",
"source",
"selector"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"pattern": "^tag:scient\\.ing,2026:annotation:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
}
},
"required": [
"type",
"source"
],
"additionalProperties": false
}
]
},
{
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"pattern": "^tag:scient\\.ing,2026:doc:[a-z0-9][a-z0-9._-]*/[a-z][a-z0-9]*-[0-9a-hjkmnp-tv-z]{4,51}(\\.[a-z0-9][a-z0-9-]*)*$"
},
"selector": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"const": "AnchorSelector"
},
"anchor": {
"$ref": "anchor.schema.json"
}
},
"required": [
"type",
"anchor"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "TextQuoteSelector"
},
"exact": {
"type": "string",
"minLength": 1
},
"prefix": {
"type": "string"
},
"suffix": {
"type": "string"
}
},
"required": [
"type",
"exact"
],
"additionalProperties": false
}
]
},
"minItems": 1
}
},
"required": [
"type",
"source",
"selector"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"type": {
"const": "SpecificResource"
},
"source": {
"type": "string",
"pattern": "^tag:scient\\.ing,2026:annotation:[a-z0-9][a-z0-9._-]*/[a-hjkmnp-tv-z][0-9a-hjkmnp-tv-z]{6,25}$"
}
},
"required": [
"type",
"source"
],
"additionalProperties": false
}
]
},
"minItems": 1
}
]
},
"status": {
"enum": [
"proposed",
"confirmed",
"rejected",
"withdrawn"
]
},
"receipt": {
"$ref": "common.schema.json#/$defs/recordId"
},
"rights_use": {
"type": "string",
"minLength": 1
}
},
"required": [
"@context",
"id",
"type",
"layer",
"motivation",
"creator",
"created",
"body",
"target",
"status"
],
"additionalProperties": false,
"allOf": [
{
"if": {
"properties": {
"status": {
"const": "confirmed"
}
}
},
"then": {
"required": [
"receipt"
]
}
}
]
}