roadmap/src/lib/data/roadmap.schema.json at main · hoardcti/roadmap · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "https://hoardcti.dev/roadmap.schema.json",
	"title": "Hoard CTI roadmap config",
	"description": "Which roadmaps exist and which GitHub repo backs each one. Milestones, issues and statuses are fetched from GitHub by scripts/fetch-roadmap.mjs.",
	"type": "object",
	"required": [
		"meta",
		"roadmaps"
	],
	"properties": {
		"$schema": {
			"type": "string"
		},
		"meta": {
			"type": "object",
			"required": [
				"name"
			],
			"properties": {
				"name": {
					"type": "string"
				},
				"tagline": {
					"type": "string"
				},
				"description": {
					"type": "string"
				},
				"github": {
					"type": "string",
					"format": "uri"
				},
				"project": {
					"type": "object",
					"description": "Org-level GitHub Project (v2) whose single-select field supplies issue statuses. Needs ROADMAP_TOKEN with project read access.",
					"required": [
						"org",
						"number"
					],
					"properties": {
						"org": {
							"type": "string"
						},
						"number": {
							"type": "integer",
							"minimum": 1
						},
						"statusField": {
							"type": "string",
							"default": "Status"
						}
					},
					"additionalProperties": false
				}
			},
			"additionalProperties": true
		},
		"roadmaps": {
			"type": "array",
			"minItems": 1,
			"items": {
				"$ref": "#/$defs/roadmap"
			}
		}
	},
	"additionalProperties": false,
	"$defs": {
		"status": {
			"enum": [
				"done",
				"in-progress",
				"planned",
				"blocked"
			],
			"description": "Unknown values fall back to 'planned' at render time."
		},
		"roadmap": {
			"type": "object",
			"required": [
				"id",
				"title"
			],
			"properties": {
				"id": {
					"type": "string",
					"pattern": "^[a-z0-9-]+$",
					"description": "URL slug. The roadmap with id 'main' (or main: true) is the front page."
				},
				"title": {
					"type": "string"
				},
				"summary": {
					"type": "string"
				},
				"icon": {
					"type": "string",
					"description": "Icon key, see src/lib/components/Icon.svelte for the available set."
				},
				"group": {
					"type": "string",
					"description": "Sidebar section heading, e.g. 'Architecture'."
				},
				"main": {
					"type": "boolean"
				},
				"status": {
					"enum": [
						"done",
						"in-progress",
						"planned",
						"blocked"
					],
					"description": "Optional override; normally derived from the GitHub issues."
				},
				"repo": {
					"type": "object",
					"required": [
						"name",
						"url"
					],
					"properties": {
						"name": {
							"type": "string"
						},
						"url": {
							"type": "string",
							"format": "uri"
						}
					},
					"additionalProperties": false,
					"description": "GitHub repository whose milestones and issues make up this roadmap."
				},
				"intro": {
					"type": "object",
					"properties": {
						"heading": {
							"type": "string"
						},
						"body": {
							"type": "string"
						},
						"callout": {
							"type": "object",
							"required": [
								"body"
							],
							"properties": {
								"type": {
									"enum": [
										"info",
										"warning",
										"success"
									]
								},
								"title": {
									"type": "string"
								},
								"body": {
									"type": "string"
								}
							},
							"additionalProperties": false
						}
					},
					"additionalProperties": false
				}
			},
			"additionalProperties": false
		}
	}
}