Skip to content

Commit caa156a

Browse files
committed
docs(schema): add descriptions for rule-related schema definitions
1 parent f70c8d8 commit caa156a

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

schema.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22
"$schema": "https://json-schema.org/draft/2020-12/schema",
33
"$defs": {
44
"BaseRuleCategory": {
5+
"description": "Whether rules activated by default are included.",
56
"type": "string",
67
"enum": [
78
"default",
89
"none"
910
]
1011
},
1112
"RuleLevel": {
13+
"description": "The configured severity or activation state of a rule instance.",
1214
"type": "string",
1315
"enum": [
1416
"on",
@@ -21,17 +23,21 @@
2123
]
2224
},
2325
"RuleOptions": {
26+
"description": "Configuration for one rule instance.",
2427
"type": "object",
2528
"properties": {
2629
"level": {
30+
"description": "The severity or activation state for this rule instance.",
2731
"$ref": "#/$defs/RuleLevel"
2832
},
2933
"parameters": {
34+
"description": "Parameter values passed to the rule implementation.",
3035
"additionalProperties": {
3136
"type": "string"
3237
}
3338
},
3439
"templateRuleKey": {
40+
"description": "Optional rule implementation/template key, qualified as repository:rule when needed.",
3541
"type": "string"
3642
}
3743
}
@@ -40,9 +46,11 @@
4046
"type": "object",
4147
"properties": {
4248
"base": {
49+
"description": "The base set of rules to activate.",
4350
"$ref": "#/$defs/BaseRuleCategory"
4451
},
4552
"rules": {
53+
"description": "Configured rule instances keyed by their user-facing rule identity.",
4654
"additionalProperties": {
4755
"oneOf": [
4856
{

0 commit comments

Comments
 (0)