github/bug-receipt — references/receipt.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://lmysticl.github.io/bug-receipt/receipt.schema.json",
  "title": "Bug Receipt",
  "description": "A machine-readable evidence receipt for a software bug fix.",
  "type": "object",
  "additionalProperties": false,
  "required": ["version", "status", "problem", "baseline", "rootCause", "changes", "verification", "gaps"],
  "properties": {
    "version": { "const": 1 },
    "status": { "enum": ["verified", "partial", "blocked"] },
    "problem": { "$ref": "#/$defs/nonEmptyString" },
    "baseline": {
      "type": "object",
      "additionalProperties": false,
      "required": ["command", "result", "evidence"],
      "properties": {
        "command": { "$ref": "#/$defs/nonEmptyString" },
        "result": { "enum": ["failed", "observed", "not-run"] },
        "evidence": { "$ref": "#/$defs/nonEmptyString" }
      }
    },
    "rootCause": {
      "type": "object",
      "additionalProperties": false,
      "required": ["summary", "evidence"],
      "properties": {
        "summary": { "$ref": "#/$defs/nonEmptyString" },
        "evidence": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": ["location", "observation"],
            "properties": {
              "location": { "$ref": "#/$defs/nonEmptyString" },
              "observation": { "$ref": "#/$defs/nonEmptyString" }
            }
          }
        }
      }
    },
    "changes": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": ["file", "summary"],
        "properties": {
          "file": { "$ref": "#/$defs/nonEmptyString" },
          "summary": { "$ref": "#/$defs/nonEmptyString" }
        }
      }
    },
    "verification": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": ["command", "result", "evidence"],
        "properties": {
          "command": { "$ref": "#/$defs/nonEmptyString" },
          "result": { "enum": ["passed", "failed", "not-run"] },
          "evidence": { "$ref": "#/$defs/nonEmptyString" }
        }
      }
    },
    "gaps": { "type": "array", "items": { "$ref": "#/$defs/nonEmptyString" } }
  },
  "$defs": {
    "nonEmptyString": { "type": "string", "minLength": 1, "pattern": "\\S" }
  },
  "allOf": [
    {
      "if": { "properties": { "status": { "const": "verified" } }, "required": ["status"] },
      "then": {
        "properties": {
          "baseline": { "type": "object", "properties": { "result": { "enum": ["failed", "observed"] } } },
          "rootCause": { "type": "object", "properties": { "evidence": { "type": "array", "minItems": 1 } } },
          "changes": { "type": "array", "minItems": 1 },
          "verification": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "result": { "const": "passed" } } } },
          "gaps": { "type": "array", "maxItems": 0 }
        }
      }
    },
    {
      "if": { "properties": { "status": { "enum": ["partial", "blocked"] } }, "required": ["status"] },
      "then": { "properties": { "gaps": { "type": "array", "minItems": 1 } } }
    }
  ]
}