revisionNotes

revisionNotes schema JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://msp-1.org/schema/revisionNotes/revisionNotes.json",
  "title": "MSP-1 Revision Notes Schema",
  "description": "Schema for providing human-readable explanation of what changed in a revision, why the change was made, and any relevant context needed to interpret the change.",
  "$comment": "MSP-1 v1.0.2 allows both the lean string form and the structured object form for revisionNotes. String form is preferred inside ordinary revision objects. For object form, notes is required. The notes field corresponds to the string form when revisionNotes is emitted as a plain string. revisionNotes explain change context but do not themselves establish correctness, reliability, verification, trust, or ranking priority.",
  "anyOf": [
    {
      "type": "string",
      "minLength": 1,
      "description": "A plain-text natural-language explanation of what changed in the revision."
    },
    {
      "type": "object",
      "properties": {
        "notes": {
          "type": "string",
          "minLength": 1,
          "description": "Primary revision notes describing what changed and why."
        },
        "author": {
          "type": "string",
          "description": "Name or identifier of the person, organization, or system that authored the revision notes."
        },
        "date": {
          "type": "string",
          "format": "date",
          "description": "Date when the revision notes were created."
        },
        "context": {
          "type": "string",
          "description": "Optional contextual explanation for why the revision occurred."
        },
        "relatedRevision": {
          "type": "string",
          "description": "Identifier or version associated with the revision these notes refer to."
        },
        "confidence": {
          "type": "string",
          "enum": [
            "low",
            "medium",
            "high"
          ],
          "description": "Optional confidence rating in the accuracy or completeness of the revision notes."
        },
        "additionalDetails": {
          "type": "array",
          "description": "Optional list of detailed points, examples, sub-notes, or clarifications.",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}