JSON Schema definitions for all pipeline handover contracts including issue analysis, research, enhancement, and sync flows. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
39 lines
1.4 KiB
JSON
39 lines
1.4 KiB
JSON
{
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"title": "Doc Sync Scan Results",
|
|
"description": "Documentation inconsistency scan for doc-sync pipeline",
|
|
"type": "object",
|
|
"required": ["scan_scope", "findings", "summary", "timestamp"],
|
|
"properties": {
|
|
"scan_scope": { "type": "string", "minLength": 1 },
|
|
"findings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": ["id", "type", "severity", "title", "description"],
|
|
"properties": {
|
|
"id": { "type": "string", "pattern": "^DOC-[0-9]{3}$" },
|
|
"type": { "type": "string", "enum": ["MISSING_DOCS", "STALE_DOCS", "INACCURATE", "INCOMPLETE"] },
|
|
"severity": { "type": "string", "enum": ["CRITICAL", "HIGH", "MEDIUM", "LOW"] },
|
|
"title": { "type": "string", "minLength": 3 },
|
|
"doc_location": { "type": "string" },
|
|
"code_location": { "type": "string" },
|
|
"description": { "type": "string", "minLength": 10 },
|
|
"suggested_fix": { "type": "string" }
|
|
}
|
|
}
|
|
},
|
|
"summary": {
|
|
"type": "object",
|
|
"required": ["total_findings"],
|
|
"properties": {
|
|
"total_findings": { "type": "integer", "minimum": 0 },
|
|
"by_type": { "type": "object" },
|
|
"by_severity": { "type": "object" },
|
|
"fixable_count": { "type": "integer", "minimum": 0 }
|
|
}
|
|
},
|
|
"timestamp": { "type": "string", "format": "date-time" }
|
|
}
|
|
}
|