oss-signal/docs/schema/rules-catalog.schema.json at main · SalmonPlays/oss-signal · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://salmonplays.github.io/oss-signal/schema/rules-catalog.schema.json",
  "title": "oss-signal rule catalog JSON",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "tool",
    "version",
    "totalRules",
    "totalWeight",
    "scoring",
    "categories"
  ],
  "properties": {
    "tool": {
      "const": "oss-signal"
    },
    "version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+(-[0-9A-Za-z.-]+)?$"
    },
    "totalRules": {
      "type": "integer",
      "minimum": 0
    },
    "totalWeight": {
      "type": "integer",
      "minimum": 0
    },
    "scoring": {
      "type": "object",
      "additionalProperties": false,
      "required": ["description", "grades"],
      "properties": {
        "description": {
          "type": "string",
          "minLength": 1
        },
        "grades": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": ["grade", "range"],
            "properties": {
              "grade": {
                "type": "string",
                "enum": ["A", "B", "C", "D", "F"]
              },
              "range": {
                "type": "string",
                "minLength": 1
              }
            }
          }
        }
      }
    },
    "categories": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/category"
      }
    }
  },
  "$defs": {
    "category": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "label", "rules"],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "label": {
          "type": "string",
          "minLength": 1
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/rule"
          }
        }
      }
    },
    "rule": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "label", "weight", "signals", "why", "fix"],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "label": {
          "type": "string",
          "minLength": 1
        },
        "weight": {
          "type": "integer",
          "minimum": 0
        },
        "signals": {
          "type": "array",
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "why": {
          "type": "string",
          "minLength": 1
        },
        "fix": {
          "type": "string",
          "minLength": 1
        }
      }
    }
  }
}