Schemas / Record
rig.record.mark
v1.0.0 · stable maturity: draft 5 fields 1 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
class |
enumpublic · internal · confidential · pii · phi · pci · cui · classified | required | public / internal / confidential / pii / phi / pci / cui / classified |
marking |
string | optional | Optional. Banner as written (CUI//SP-PRVCY) |
purpose |
string | optional | Optional. Why this fact is held (payment-auth, treatment) |
disposition |
enumkeep · tombstone · hold | optional | Optional. keep / tombstone / hold; absent = unknown |
retainYears |
integer0 – * | optional | Optional. Years to keep after the fact's day. 0 means do not retain |
Classification and retention of a fact. Format when present.
This schema is the perimeter a host must honour - not copyright of a work (rig.rights.statement), not an access-control list, and not a query audit.
class is required. Compose onto any entity. A second mark is another entity - do not stack two marks on one fact.
classified is the national-security class. The written banner stays on marking. Hot, warm, and cold storage stay in the host.
JSON Schema
Resolves at https://rig.works/schemas/rig.record.mark.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.record.mark.schema.json",
"title": "rig.record.mark",
"type": "object",
"additionalProperties": false,
"properties": {
"class": {
"type": "string",
"enum": [
"public",
"internal",
"confidential",
"pii",
"phi",
"pci",
"cui",
"classified"
]
},
"marking": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"purpose": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"disposition": {
"type": "string",
"enum": [
"keep",
"tombstone",
"hold"
]
},
"retainYears": {
"type": "integer",
"minimum": 0
}
},
"required": [
"class"
],
"description": "Classification and retention of a fact. Not copyright (rig.rights.statement) and not an ACL.",
"x-rig-maturity": "draft"
}