mirror of
https://github.com/profullstack/logicsrc.git
synced 2026-08-13 14:37:26 +00:00
Anthony Ettinger
257d581331
Follow-up to #96. The template and tool-generated PRDs (moshcode /prd) ship optional keys blank; YAML reads them as null. Accept null on owner/repo/created/ updated/discussion/implementation/tags/supersedes/superseded-by/authors so template-derived files validate against the schema. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
79 lines
3.1 KiB
JSON
79 lines
3.1 KiB
JSON
{
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://schemas.logicsrc.com/openprd-prd.schema.json",
|
|
"title": "OpenPRD Product Requirements Document",
|
|
"description": "The front-matter manifest of an OpenPRD document. OpenPRD is a lightweight, DIP-style proposal standard: a repo publishes a numbered collection of PRDs under prd/ (prd/NNNN-slug.md), with a 0000-template.md and a README index, committed to the repo like a BIP/EIP/DIP process. This schema governs the YAML front-matter; the body is Markdown with a fixed set of sections. Optional keys MAY be present but empty (null) — the template ships them blank for authors to fill.",
|
|
"type": "object",
|
|
"required": ["openprd", "id", "title", "status"],
|
|
"additionalProperties": false,
|
|
"properties": {
|
|
"openprd": {
|
|
"type": "string",
|
|
"pattern": "^\\d+\\.\\d+(\\.\\d+)?$",
|
|
"description": "OpenPRD standard version this document conforms to, e.g. '0.2'."
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"pattern": "^\\d{4}$",
|
|
"description": "Four-digit zero-padded number, monotonically increasing with no gaps. Matches the filename prefix: prd/<id>-<slug>.md."
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"minLength": 1,
|
|
"description": "Short imperative title — start with a verb where possible."
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"enum": ["Draft", "Review", "Accepted", "Final", "Rejected", "Withdrawn", "Superseded"],
|
|
"description": "Lifecycle stage. Draft → Review → Accepted → Final; or Rejected/Withdrawn/Superseded."
|
|
},
|
|
"authors": {
|
|
"type": ["array", "null"],
|
|
"items": { "type": "string" },
|
|
"uniqueItems": true,
|
|
"description": "Author identities — email, handle, or DID."
|
|
},
|
|
"owner": {
|
|
"type": ["string", "null"],
|
|
"description": "Optional DID or handle of the accountable owner (e.g. a LogicSRC account/agent DID)."
|
|
},
|
|
"repo": {
|
|
"type": ["string", "null"],
|
|
"description": "Optional owner/name of the repository this PRD targets."
|
|
},
|
|
"created": {
|
|
"type": ["string", "null"],
|
|
"format": "date",
|
|
"description": "ISO date (YYYY-MM-DD) the PRD was created."
|
|
},
|
|
"updated": {
|
|
"type": ["string", "null"],
|
|
"format": "date",
|
|
"description": "ISO date (YYYY-MM-DD) of the last substantive edit."
|
|
},
|
|
"discussion": {
|
|
"type": ["string", "null"],
|
|
"description": "Optional URL to the PR/issue/thread where this PRD is discussed."
|
|
},
|
|
"implementation": {
|
|
"type": ["string", "null"],
|
|
"description": "Optional URL/reference to the implementation PR or tracking issue."
|
|
},
|
|
"tags": {
|
|
"type": ["array", "null"],
|
|
"items": { "type": "string" },
|
|
"uniqueItems": true,
|
|
"description": "Optional freeform labels for grouping PRDs."
|
|
},
|
|
"supersedes": {
|
|
"type": ["string", "null"],
|
|
"pattern": "^\\d{4}$",
|
|
"description": "Optional id of an earlier PRD this one replaces."
|
|
},
|
|
"superseded-by": {
|
|
"type": ["string", "null"],
|
|
"pattern": "^\\d{4}$",
|
|
"description": "Optional id of a later PRD that replaces this one."
|
|
}
|
|
}
|
|
}
|