tods-validate/docs/v1-contract-candidate.json at main · ghzhost/tods-validate · 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
{
  "contractVersion": "v1-candidate-1",
  "cliExitCodes": {
    "clean": 0,
    "findingsAtOrAboveThreshold": 1,
    "usageOrInputError": 2
  },
  "supportedSpecVersions": [
    "1.0.0",
    "2.1.0"
  ],
  "jsonReport": {
    "reportVersion": "1.3.0",
    "requiredTopLevel": [
      "validator",
      "specVersion",
      "source",
      "summary",
      "findings"
    ],
    "requiredFindingFields": [
      "rule_id",
      "severity",
      "file",
      "row",
      "field",
      "location",
      "data",
      "message",
      "suggestion",
      "caused_by",
      "fingerprint",
      "severity_original"
    ]
  },
  "pythonExports": {
    "tods_validate": [
      "Finding",
      "Severity",
      "Suggestion",
      "ValidationResult",
      "__version__",
      "suggest_fixes",
      "validate_feed"
    ],
    "tods_validate.read": [
      "CompanionGTFS",
      "FeedFile",
      "Package",
      "PackageNotFoundError",
      "Row",
      "build_companion",
      "load_package",
      "merge_supplement",
      "to_dataframe",
      "to_rows"
    ],
    "tods_validate.testing": [
      "assert_feed_produces",
      "assert_feed_valid"
    ]
  },
  "rules": [
    ["TODS-W101", "WARNING", "core"],
    ["TODS-I102", "INFO", "core"],
    ["TODS-E103", "ERROR", "core"],
    ["TODS-E104", "ERROR", "core"],
    ["TODS-E105", "ERROR", "core"],
    ["TODS-E106", "ERROR", "core"],
    ["TODS-W107", "WARNING", "core"],
    ["TODS-I108", "INFO", "core"],
    ["TODS-E201", "ERROR", "core"],
    ["TODS-E202", "ERROR", "core"],
    ["TODS-E203", "ERROR", "core"],
    ["TODS-E204", "ERROR", "core"],
    ["TODS-E205", "ERROR", "core"],
    ["TODS-W206", "WARNING", "core"],
    ["TODS-E207", "ERROR", "core"],
    ["TODS-E301", "ERROR", "core"],
    ["TODS-W302", "WARNING", "core"],
    ["TODS-E303", "ERROR", "core"],
    ["TODS-E304", "ERROR", "core"],
    ["TODS-W305", "WARNING", "core"],
    ["TODS-W306", "WARNING", "core"],
    ["TODS-E307", "ERROR", "core"],
    ["TODS-E308", "ERROR", "core"],
    ["TODS-E309", "ERROR", "core"],
    ["TODS-E310", "ERROR", "core"],
    ["TODS-E311", "ERROR", "core"],
    ["TODS-E312", "ERROR", "core"],
    ["TODS-W313", "WARNING", "core"],
    ["TODS-E314", "ERROR", "core"],
    ["TODS-W315", "WARNING", "core"],
    ["TODS-W316", "WARNING", "core"],
    ["TODS-E401", "ERROR", "core"],
    ["TODS-E402", "ERROR", "core"],
    ["TODS-W403", "WARNING", "core"],
    ["TODS-W404", "WARNING", "core"],
    ["TODS-E405", "ERROR", "core"],
    ["TODS-W406", "WARNING", "core"],
    ["TODS-W407", "WARNING", "core"],
    ["TODS-W408", "WARNING", "core"],
    ["TODS-W409", "WARNING", "core"],
    ["TODS-I501", "INFO", "coverage"],
    ["TODS-I502", "INFO", "coverage"],
    ["TODS-I601", "INFO", "advisory"]
  ]
}