forked from ChelseaKR/gtfs-scorecard
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdirectory.schema.json
More file actions
478 lines (478 loc) · 13.5 KB
/
Copy pathdirectory.schema.json
File metadata and controls
478 lines (478 loc) · 13.5 KB
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://gtfsscorecard.org/schemas/directory.schema.json",
"title": "GTFS Scorecard national directory",
"description": "Slim per-scorecard directory plus guarded covered-corpus and location summaries. Additive within a major schema_version: tolerate unknown fields.",
"type": "object",
"required": [
"schema_version",
"summary",
"agencies"
],
"properties": {
"schema_version": {
"type": "string"
},
"license": {
"type": "string"
},
"attribution": {
"type": "string"
},
"generated_at": {
"type": "string"
},
"summary": {
"type": "object",
"required": [
"agencies",
"grade_distribution"
],
"properties": {
"agencies": {
"type": "integer",
"minimum": 0
},
"feed_records": {
"type": "integer",
"minimum": 0
},
"scored_feed_records": {
"type": "integer",
"minimum": 0
},
"comparison_eligible_count": {
"type": "integer",
"minimum": 0
},
"average_score": {
"type": [
"number",
"null"
]
},
"median_score": {
"type": [
"number",
"null"
]
},
"grade_distribution": {
"type": "object",
"additionalProperties": {
"type": "integer"
}
},
"expiring_soon": {
"type": "integer",
"minimum": 0
},
"expired": {
"type": "object",
"properties": {
"lapsed": {
"type": "integer"
},
"stale": {
"type": "integer"
},
"total": {
"type": "integer"
}
}
},
"states": {
"type": "array",
"items": {
"type": "object",
"required": [
"state",
"agencies"
],
"properties": {
"state": {
"type": "string"
},
"agencies": {
"type": "integer"
},
"feed_records": {
"type": "integer",
"minimum": 0
},
"comparison_eligible_count": {
"type": "integer",
"minimum": 0
},
"average_score": {
"type": [
"number",
"null"
]
},
"grade_distribution": {
"type": "object"
},
"expired": {
"type": "integer"
}
}
}
},
"countries": {
"type": "array",
"description": "Portable country rollups with nested ISO 3166-2 subdivisions. The legacy states array is unchanged.",
"items": {
"type": "object",
"required": [
"country_code",
"country_name",
"agencies",
"subdivisions"
],
"properties": {
"country_code": {
"type": ["string", "null"],
"pattern": "^[A-Z]{2}$"
},
"country_name": {
"type": "string"
},
"agencies": {
"type": "integer",
"minimum": 0
},
"feed_records": {
"type": "integer",
"minimum": 0
},
"comparison_eligible_count": {
"type": "integer",
"minimum": 0
},
"average_score": {
"type": ["number", "null"]
},
"grade_distribution": {
"type": "object"
},
"expired": {
"type": "integer",
"minimum": 0
},
"subdivisions": {
"type": "array",
"items": {
"type": "object",
"required": [
"subdivision_code",
"subdivision_name",
"agencies"
],
"properties": {
"subdivision_code": {
"type": ["string", "null"],
"pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$"
},
"subdivision_name": {
"type": "string"
},
"agencies": {
"type": "integer",
"minimum": 0
},
"feed_records": {
"type": "integer",
"minimum": 0
},
"comparison_eligible_count": {
"type": "integer",
"minimum": 0
},
"average_score": {
"type": ["number", "null"]
},
"grade_distribution": {
"type": "object"
},
"expired": {
"type": "integer",
"minimum": 0
}
}
}
}
}
}
},
"size_tiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"label": {
"type": "string"
},
"agencies": {
"type": "integer"
},
"feed_records": {
"type": "integer"
}
}
}
},
"comparison": {
"type": "object",
"required": [
"eligible_count",
"excluded_count",
"required_rubric_version",
"required_scoring_profile_id",
"required_validator_version",
"required_measured_categories",
"measured_category_cohorts",
"exclusion_counts",
"absolute_rankings_published",
"individual_percentiles_published",
"note"
],
"properties": {
"eligible_count": {"type": "integer", "minimum": 0},
"excluded_count": {"type": "integer", "minimum": 0},
"required_rubric_version": {"type": "string"},
"required_scoring_profile_id": {"type": "string"},
"required_validator_version": {"type": "string"},
"required_reader_archive_profile": {"type": "string"},
"required_measured_categories": {
"type": "array",
"items": {
"enum": ["correctness", "freshness", "completeness", "realtime"]
},
"uniqueItems": true
},
"measured_category_cohorts": {
"type": "object",
"additionalProperties": {"type": "integer", "minimum": 0}
},
"absolute_rankings_published": {"const": false},
"individual_percentiles_published": {"const": false},
"exclusion_counts": {"type": "object", "additionalProperties": {"type": "integer"}},
"note": {"type": "string"}
}
}
}
},
"agencies": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"grade",
"score"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"state": {
"type": "string"
},
"subdivision_code": {
"type": "string",
"pattern": "^[A-Z]{2}-[A-Z0-9]{1,3}$"
},
"subdivision_name": {
"type": "string"
},
"grade": {
"type": "string",
"enum": [
"A",
"B",
"C",
"D",
"F"
]
},
"score": {
"type": "number"
},
"comparison_eligible": {
"type": "boolean",
"description": "Whether this row belongs to the comparison cohort documented in summary.comparison."
},
"correctness": {
"type": ["number", "null"]
},
"freshness": {
"type": ["number", "null"]
},
"completeness": {
"type": ["number", "null"]
},
"realtime": {
"type": ["number", "null"]
},
"size_tier": {
"type": "string"
},
"national_percentile": {
"type": ["integer", "null"],
"minimum": 0,
"maximum": 100,
"deprecated": true,
"description": "Deprecated compatibility field. Current payloads publish null; integers remain valid only so historical 1.x documents still conform."
},
"peer_percentile": {
"type": ["integer", "null"],
"minimum": 0,
"maximum": 100,
"deprecated": true,
"description": "Deprecated compatibility field. Current payloads publish null; integers remain valid only so historical 1.x documents still conform."
},
"expiry_status": {
"type": "string"
},
"days_until_expiry": {
"type": [
"integer",
"null"
]
},
"mdb_id": {
"type": "string"
},
"ntd_ready": {
"type": [
"string",
"null"
],
"enum": [
"ready",
"at_risk",
"not_ready",
null
],
"description": "NTD GTFS certification readiness heads-up; null for non-US agencies (see catalog schema)."
},
"google_gate": {
"type": "string",
"enum": [
"pass",
"at_risk",
"fail"
],
"description": "Google/Apple Maps four-week coverage bar (see catalog schema)."
},
"stops": {
"type": [
"integer",
"null"
],
"description": "Boardable stop count from stops.txt."
},
"feed_url": {
"type": [
"string",
"null"
],
"description": "The static GTFS URL that was scored."
},
"feed_sha256": {
"type": [
"string",
"null"
],
"description": "SHA-256 of the exact feed bytes scored."
},
"reader_archive_profile": {
"type": "string",
"enum": ["raw-v1", "flat-single-root-v1"]
},
"retrieved_at": {
"type": [
"string",
"null"
],
"description": "When the feed was fetched and scored (ISO 8601)."
},
"snapshot_date": {
"type": [
"string",
"null"
],
"description": "The scorecard's snapshot date (YYYY-MM-DD)."
},
"rubric_version": {
"type": [
"string",
"null"
],
"description": "Rubric version that produced this grade."
},
"scoring_profile_id": {
"type": ["string", "null"],
"description": "Stable scoring-profile identifier that produced this grade."
},
"scoring_profile_rubric_version": {
"type": ["string", "null"],
"description": "Rubric version declared by the scoring profile."
},
"validator_version": {
"type": [
"string",
"null"
],
"description": "MobilityData gtfs-validator release used."
},
"scorecard_url": {
"type": [
"string",
"null"
],
"description": "Canonical scorecard page for this agency."
},
"top_fix": {
"type": [
"string",
"null"
],
"description": "The highest-leverage plain-language fix, when any."
},
"country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "ISO 3166-1 alpha-2 country code. Registry configuration determines which well-formed country codes this deployment activates."
},
"modes_measured": {
"type": "boolean",
"description": "Whether the route-mode contract was measured for this feed."
},
"primary_mode": {
"type": ["string", "null"]
},
"modes": {
"type": ["array", "null"],
"items": { "type": "string" },
"uniqueItems": true
},
"has_ferry": {
"type": ["boolean", "null"]
},
"ferry_only": {
"type": ["boolean", "null"]
}
}
}
}
}
}