View schema JSON
The formal JSON schema defining the expected structure and fields for the MSP-1 revision term.
MSP-1 schema
revision
Describes a discrete change event in the lifecycle of an MSP-1 resource, providing a stable anchor for revision identity, date, version association, and explanatory notes.
revision schema definition
Machine-readable structure for declaring a documented change event using a lean object form.
revision schema JSON
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://msp-1.org/schema/revision/revision.json",
"title": "MSP-1 Revision Schema",
"description": "Schema for describing a discrete change event in the lifecycle of an MSP-1 resource, providing a stable anchor for revision identity, date, version association, and explanatory notes.",
"$comment": "MSP-1 v1.0.2 uses object form as canonical for revision. id is required as the stable revision identity field. revisionDate, revisionNotes, and revisionVersion are the preferred explicit revision subterms. version, date, summary, and notes are compatibility fields for older revision structures. revisionVersion is not the same as protocol.version.",
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"description": "Stable identifier for the revision event."
},
"revisionDate": {
"type": "string",
"format": "date",
"description": "Date associated with the revision event."
},
"revisionNotes": {
"type": "string",
"description": "Human-readable explanation of what changed and, when useful, why it changed."
},
"revisionVersion": {
"type": "string",
"description": "Version identifier associated with this revision event."
},
"updatedBy": {
"type": "string",
"description": "Identifier of the person, organization, or system that performed the update."
},
"reviewer": {
"type": "object",
"description": "Optional reviewer metadata associated with this revision."
},
"provenance": {
"type": "object",
"description": "Optional provenance metadata associated with the change event."
},
"relatedChanges": {
"type": "array",
"description": "Optional list of related revisions, resources, or identifiers affected by this change.",
"items": {
"type": "string"
}
},
"confidence": {
"type": "string",
"enum": [
"low",
"medium",
"high"
],
"description": "Optional confidence level in the accuracy or completeness of the recorded revision details."
},
"version": {
"type": "string",
"description": "Compatibility field for older revision structures. Prefer revisionVersion in new MSP-1 v1.0.2 output."
},
"date": {
"type": "string",
"format": "date",
"description": "Compatibility field for older revision structures. Prefer revisionDate in new MSP-1 v1.0.2 output."
},
"summary": {
"type": "string",
"description": "Compatibility field for older revision structures. Prefer revisionNotes when describing the revision change."
},
"notes": {
"type": "string",
"description": "Compatibility field for older revision structures. Prefer revisionNotes in new MSP-1 v1.0.2 output."
}
},
"required": [
"id"
],
"additionalProperties": false
}
Namespace reference
See the corresponding namespace term for conceptual usage, examples, and related MSP-1 terms.
Schema notes
The canonical MSP-1 v1.0.2 form for revision is an object with id as the required revision identity field.
revisionDate, revisionNotes, and revisionVersion are the preferred explicit revision subterms. Legacy fields such as version, date, summary, and notes may receive compatibility handling, but new MSP-1 v1.0.2 output should prefer the explicit revision field names.