Support including some information about where a test behavior is spe…

…cified. Refs: json-schema-org/JSON-Schema-Test-Suite#699
python-jsonschema · Nov 8, 2023 · 0ba3ce7 · 0ba3ce7
1 parent bb52b77
commit 0ba3ce7
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/test-schema.json b/test-schema.json
@@ -30,6 +30,38 @@
       "type": "object",
       "properties": {
         "base_uri": { "type": "string", "format": "uri" },
+        "why": {
+          "description": "A human-readable explanation of the results of this test.",
+          "type": "object",
+          "unevaluatedProperties": false,
+          "properties": {
+            "summary": {
+              "description": "A summary of the behavior specified in the linked specifications",
+              "type": "string"
+            },
+            "specifications": {
+              "description": "One or more releavnt specifications for this test.",
+              "type": "array",
+              "minItems": 1,
+              "items": {
+                "type": "object",
+                "oneOf": [{ "required": ["rfc"] }, { "required": ["name"] }],
+                "properties": {
+                  "rfc": {
+                    "description": "An IETF RFC",
+                    "type": "number"
+                  },
+                  "name": {
+                    "description": "Any other specification",
+                    "type": "string"
+                  },
+                  "section": { "type": "string" },
+                  "link": { "type": "string", "format": "uri" }
+                }
+              }
+            }
+          }
+        },
         "ref": { "type": "string" },
         "target": {},
         "then": {