Merge pull request #246 from DataDog/jacobotb/STAL-1373/version

Add a schema-version field to the configuration file JSON Schema.
DataDog · Mar 5, 2024 · 97d161b · 97d161b
2 parents f805427 + f02f34d
commit 97d161b
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ All the rules can be found on the [Datadog documentation](https://docs.datadoghq
 Example of YAML file
 
 ```yaml
+schema-version: v1
 rulesets:
   - python-code-style
   - python-best-practices
@@ -141,6 +142,7 @@ at the root directory of the repository. This is a YAML file with the following
 Example of configuration:
 
 ```yaml
+schema-version: v1
 rulesets:
   - python-code-style
   - python-best-practices

diff --git a/schema/examples/invalid/invalid-version.yml b/schema/examples/invalid/invalid-version.yml
@@ -0,0 +1,5 @@
+schema-version: v0
+rulesets:
+  - python-best-practices
+  - java-best-practices
+  - python-security
diff --git a/schema/examples/valid/arguments.yml b/schema/examples/valid/arguments.yml
@@ -1,3 +1,4 @@
+schema-version: v1
 rulesets:
   - lorem_ipsum:
     ignore:

diff --git a/schema/examples/valid/complex1.yml b/schema/examples/valid/complex1.yml
@@ -1,3 +1,4 @@
+schema-version: v1
 rulesets:
   - python-best-practices
   - go-best-practices:

diff --git a/schema/examples/valid/complex2.yml b/schema/examples/valid/complex2.yml
@@ -1,3 +1,4 @@
+schema-version: v1
 rulesets:
   - python-best-practices
   - java-best-practices:

diff --git a/schema/examples/valid/extensions.yml b/schema/examples/valid/extensions.yml
@@ -1,5 +1,6 @@
 # Additional fields not handled by the schema are accepted.
 # (Additional field names do NOT have to start with x-. This is done for tests only.)
+schema-version: v1
 rulesets:
   - java-best-practices:
     x-ruleset-field: abc

diff --git a/schema/schema.json b/schema/schema.json
@@ -2,6 +2,11 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
+    "schema-version": {
+      "type": "string",
+      "default": "v1",
+      "enum": ["v1"]
+    },
     "rulesets": {
       "type": "array",
       "items": {