forked from tobie/specref
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathraw-reference.json
256 lines (255 loc) · 9.5 KB
/
raw-reference.json
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"title": "Specref",
"description": "A list of spec references.",
"patternProperties": {
"^[a-zA-Z0-9\\-_+\\.]+$": {
"oneOf": [
{ "$ref": "#/definitions/alias" },
{ "$ref": "#/definitions/legacyRef" },
{ "$ref": "#/definitions/ref" }
]
}
},
"additionalProperties": false,
"definitions": {
"nonEmptyString": {
"definition": "A non-empty string.",
"type": "string",
"minLength":1
},
"url": {
"definition": "An URL string.",
"type": "string",
"format": "uri"
},
"urlList": {
"definition": "An array of unique URLs.",
"type": "array",
"items": {
"$ref": "#/definitions/url"
},
"minItems": 1,
"uniqueItems": true
},
"id": {
"definition": "A reference ID (corresponds to RFCs or W3C shortnames).",
"type": "string",
"pattern": "^[a-zA-Z0-9\\-_+\\.]+$"
},
"idList": {
"definition": "An array of unique reference IDs.",
"type": "array",
"items": {
"$ref": "#/definitions/id"
},
"minItems": 1,
"uniqueItems": true
},
"authors": {
"description": "Authors of the specification",
"type": "array",
"items": { "$ref": "#/definitions/nonEmptyString" },
"minItems": 1
},
"version": {
"type": "object",
"properties": {
"authors": { "$ref": "#/definitions/authors" },
"etAl": {
"description": "Indicates extra, unlisted spec authors",
"type": "boolean"
},
"href": {
"description": "URL of the spec",
"$ref": "#/definitions/url"
},
"title": {
"description": "Title of the spec",
"$ref": "#/definitions/nonEmptyString"
},
"deliveredBy": {
"description": "An array of URLs pointing to the home page of the Working Groups working on the spec.",
"$ref": "#/definitions/urlList"
},
"rawDate": {
"description": "A prefered, machine readable format (YYYY-MM-DD) to specify the date. Note month and day are optional.",
"type": "string",
"pattern": "^\\d{4}(?:-[01]\\d)?(?:-[0-3]\\d)?$"
},
"status": {
"description": "What state the spec is in. Is it a in progress, completed, etc.",
"$ref": "#/definitions/nonEmptyString"
},
"publisher": {
"description": "Name of the publisher, if any.",
"$ref": "#/definitions/nonEmptyString"
},
"isRetired": {
"description": "The spec has been retired.",
"type": "boolean"
},
"hasErrata": {
"description": "",
"$ref": "#/definitions/url"
},
"isSuperseded": {
"description": "",
"type": "boolean"
},
"source": {
"description": "",
"$ref": "#/definitions/nonEmptyString"
},
"versionOf": {
"description": "",
"$ref": "#/definitions/id"
},
"aliases": {
"description": "",
"$ref": "#/definitions/idList"
}
},
"required": ["href"],
"additionalProperties": false
},
"legacyRef": {
"description": "Legacy, unstructured data. Please don't do this. Please help get it fixed: https://github.com/tobie/specref/issues/147",
"type": "string"
},
"alias": {
"type": "object",
"properties": {
"aliasOf": {
"description": "ID of the aliased reference. Note aliasing can be recursive.",
"$ref": "#/definitions/id"
}
},
"required": ["aliasOf"],
"additionalProperties": false
},
"ref": {
"type": "object",
"properties": {
"authors": {
"description": "Authors of the specification",
"type": "array",
"items": { "$ref": "#/definitions/nonEmptyString" },
"minItems": 1
},
"etAl": {
"description": "Indicates extra, unlisted spec authors",
"type": "boolean"
},
"href": {
"description": "URL of the spec",
"$ref": "#/definitions/url"
},
"title": {
"description": "Title of the spec",
"$ref": "#/definitions/nonEmptyString"
},
"date": {
"description": "Date of publication in humand readable form, favor rawDate instead.",
"$ref": "#/definitions/nonEmptyString"
},
"deliveredBy": {
"description": "An array of URLs pointing to the home page of the Working Groups working on the spec.",
"$ref": "#/definitions/urlList"
},
"rawDate": {
"description": "A prefered, machine readable format (YYYY-MM-DD) to specify the date. Note month and day are optional.",
"type": "string",
"pattern": "^\\d{4}(?:-[01]\\d)?(?:-[0-3]\\d)?$"
},
"status": {
"description": "What state a spec is in. Is it a work in progress, completed, etc.",
"$ref": "#/definitions/nonEmptyString"
},
"publisher": {
"description": "Name of the publisher if any.",
"$ref": "#/definitions/nonEmptyString"
},
"isRetired": {
"description": "",
"type": "boolean"
},
"hasErrata": {
"description": "",
"$ref": "#/definitions/url"
},
"isSuperseded": {
"description": "",
"type": "boolean"
},
"source": {
"description": "",
"$ref": "#/definitions/nonEmptyString"
},
"updates": {
"description": "",
"$ref": "#/definitions/idList"
},
"obsoletes": {
"description": "",
"$ref": "#/definitions/idList"
},
"updatedBy": {
"description": "",
"$ref": "#/definitions/idList"
},
"obsoletedBy": {
"description": "Array of identifiers of specs which have replaced this one",
"$ref": "#/definitions/idList"
},
"rfcNumber": {
"description": "",
"type": "string",
"pattern": "^RFC\\d{4}$"
},
"seeAlso": {
"description": "",
"$ref": "#/definitions/idList"
},
"versionOf": {
"description": "",
"$ref": "#/definitions/id"
},
"versions": {
"description": "An object listing specific versions of that spec.",
"type": "object",
"patternProperties": {
"^[a-zA-Z0-9\\-_+\\.]+$": {
"oneOf": [
{ "$ref": "#/definitions/version" },
{ "$ref": "#/definitions/alias" }
]
}
},
"additionalProperties": false
},
"aliases": {
"description": "This is for in internal use only and shouldn't be manually set.",
"$ref": "#/definitions/idList"
},
"edDraft": {
"description": "URL of the editor's draft",
"$ref": "#/definitions/url"
},
"isbn": {
"description": "International Standard Book Number",
"type": "string",
"pattern": "^[0-9\\-]+X?$"
},
"pages": {
"description": "Page number(s) where the reference is inside the titled document",
"type": "string",
"pattern": "^[0-9\\-,]+$"
}
},
"required": ["title"],
"additionalProperties": false
}
}
}