microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
scripts/linting/schemas/base-frontmatter.schema.json
56lines · modecode
| 1 | { |
| 2 | "$schema": "https://json-schema.org/draft/2020-12/schema", |
| 3 | "$id": "https://github.com/microsoft/hve-core/schemas/base-frontmatter.schema.json", |
| 4 | "title": "Base Frontmatter Schema", |
| 5 | "description": "Common frontmatter fields used across HVE Core documentation", |
| 6 | "type": "object", |
| 7 | "definitions": { |
| 8 | "iso8601Date": { |
| 9 | "type": "string", |
| 10 | "pattern": "^\\d{4}-\\d{2}-\\d{2}$", |
| 11 | "description": "ISO 8601 date format (YYYY-MM-DD)" |
| 12 | }, |
| 13 | "keywordsArray": { |
| 14 | "type": "array", |
| 15 | "items": { |
| 16 | "type": "string" |
| 17 | }, |
| 18 | "description": "Array of keywords for content categorization" |
| 19 | }, |
| 20 | "positiveInteger": { |
| 21 | "type": "integer", |
| 22 | "minimum": 1, |
| 23 | "description": "Positive integer value" |
| 24 | } |
| 25 | }, |
| 26 | "properties": { |
| 27 | "title": { |
| 28 | "type": "string", |
| 29 | "minLength": 1, |
| 30 | "description": "Document title" |
| 31 | }, |
| 32 | "description": { |
| 33 | "type": "string", |
| 34 | "minLength": 1, |
| 35 | "description": "Brief description of the document content" |
| 36 | }, |
| 37 | "author": { |
| 38 | "type": "string", |
| 39 | "description": "Author or team responsible for the content" |
| 40 | }, |
| 41 | "ms.date": { |
| 42 | "$ref": "#/definitions/iso8601Date" |
| 43 | }, |
| 44 | "ms.topic": { |
| 45 | "type": "string", |
| 46 | "enum": ["overview", "concept", "tutorial", "reference", "how-to", "troubleshooting", "research", "guide", "hub-page", "architecture"], |
| 47 | "description": "Microsoft documentation topic type" |
| 48 | }, |
| 49 | "keywords": { |
| 50 | "$ref": "#/definitions/keywordsArray" |
| 51 | }, |
| 52 | "estimated_reading_time": { |
| 53 | "$ref": "#/definitions/positiveInteger" |
| 54 | } |
| 55 | } |
| 56 | } |