Skip to content

Commit 119a832

Browse files
committed
Add optional id property to test schema (#698)
- Added optional id property for test cases with detailed description - Added optional id property for individual tests in /test - Both id properties are optional for backward compatibility - IDs will be made required once all test files have them The id property enables stable tracking of test cases and tests across description changes and file reorganization. Refs #698
1 parent e99b24c commit 119a832

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

test-schema.json

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111
"type": "object",
1212
"required": [ "description", "schema", "tests" ],
1313
"properties": {
14+
"id": {
15+
"description": "A stable, unique identifier for this test case. Must be unique within the version. Should never change even if the description or other properties change.",
16+
"type": "string"
17+
},
1418
"description": {
1519
"description": "The test case description",
1620
"type": "string"
@@ -102,6 +106,10 @@
102106
"type": "object",
103107
"required": [ "description", "data", "valid" ],
104108
"properties": {
109+
"id": {
110+
"description": "A stable, unique identifier for this test. Must be unique within the test case. Should never change even if the description or other properties change.",
111+
"type": "string"
112+
},
105113
"description": {
106114
"description": "The test description, briefly explaining which behavior it exercises",
107115
"type": "string"
@@ -121,4 +129,4 @@
121129
"additionalProperties": false
122130
}
123131
}
124-
}
132+
}

0 commit comments

Comments
 (0)