Skip to content

Commit 38661e9

Browse files
committed
update output's 'nested' to 'details'
1 parent a7f1aa2 commit 38661e9

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

jsonschema-core.xml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2944,10 +2944,10 @@ https://example.com/schemas/common#/$defs/allOf/1
29442944
</t>
29452945
</section>
29462946

2947-
<section title="Nested Results">
2947+
<section title="Results from Subschemas">
29482948
<t>
2949-
Nested results are generated from keywords which create a new dynamic
2950-
scope by applying a subschema to the instance or a child of the instance.
2949+
Evaluation results generated by applying a subschema to the instance
2950+
or a child of the instance.
29512951
Keywords which have multiple subschemas (e.g. "anyOf") will generally
29522952
generate an output unit for each subschema. In order to accommodate
29532953
potentially multiple results, the value of this property MUST be an
@@ -2958,16 +2958,16 @@ https://example.com/schemas/common#/$defs/allOf/1
29582958
and will hold all output units in a flat list.
29592959
</t>
29602960
<t>
2961-
For "hierarchical", this property will hold nested results in a tree
2962-
structure where each output unit may itself have nested results.
2961+
For "hierarchical", this property will contain results in a tree
2962+
structure where each output unit may itself have further nested results.
29632963
</t>
29642964
<t>
29652965
The sequence of output units within this list is not specified and
29662966
MAY be determined by the implementation. Sets of output units are
29672967
considered equivalent if they contain the same units, in any order.
29682968
</t>
29692969
<t>
2970-
The JSON key for nested results is "nested".
2970+
The JSON key for these additional results is "details".
29712971
</t>
29722972
</section>
29732973

@@ -2977,13 +2977,13 @@ https://example.com/schemas/common#/$defs/allOf/1
29772977
<t>
29782978
The output MUST be an object containing a boolean property named "valid". When
29792979
additional information about the result is required, the output MUST also contain
2980-
"nested" as described below.
2980+
"details" as described below.
29812981
<list>
29822982
<t>
29832983
"valid" - a boolean value indicating the overall validation success or failure
29842984
</t>
29852985
<t>
2986-
"nested" - the collection of results produced by subschemas
2986+
"details" - the collection of results produced by subschemas
29872987
</t>
29882988
</list>
29892989
For these examples, the following schema and instances will be used.
@@ -3177,11 +3177,11 @@ https://example.com/schemas/common#/$defs/allOf/1
31773177
root output unit.
31783178
</t>
31793179
<t>
3180-
The root output unit contains "valid" for the overall result and "nested"
3180+
The root output unit contains "valid" for the overall result and "details"
31813181
for the list of specific results. All other information is explicitly
31823182
omitted from the root output unit. If the root schema produces errors or
31833183
annotations, then the output node for the root MUST be present within the
3184-
root output unit's "nested" list with those errors or annotations.
3184+
root output unit's "details" list with those errors or annotations.
31853185
</t>
31863186
<t>
31873187
Output units which do not contain errors or annotations SHOULD be excluded
@@ -3194,7 +3194,7 @@ https://example.com/schemas/common#/$defs/allOf/1
31943194
// failing results
31953195
{
31963196
"valid": false,
3197-
"nested": [
3197+
"details": [
31983198
{
31993199
"valid": false,
32003200
"evaluationPath": "/properties/foo/allOf/0",
@@ -3228,7 +3228,7 @@ https://example.com/schemas/common#/$defs/allOf/1
32283228
// passing results
32293229
{
32303230
"valid": true,
3231-
"nested": [
3231+
"details": [
32323232
{
32333233
"valid": true,
32343234
"evaluationPath": "",
@@ -3316,13 +3316,13 @@ https://example.com/schemas/common#/$defs/allOf/1
33163316
"evaluationPath": "",
33173317
"schemaLocation": "https://json-schema.org/schemas/example#",
33183318
"instanceLocation": "",
3319-
"nested": [
3319+
"details": [
33203320
{
33213321
"valid": false,
33223322
"evaluationPath": "/properties/foo",
33233323
"schemaLocation": "https://json-schema.org/schemas/example#/properties/foo",
33243324
"instanceLocation": "/foo",
3325-
"nested": [
3325+
"details": [
33263326
{
33273327
"valid": false,
33283328
"evaluationPath": "/properties/foo/allOf/0",
@@ -3337,7 +3337,7 @@ https://example.com/schemas/common#/$defs/allOf/1
33373337
"evaluationPath": "/properties/foo/allOf/1",
33383338
"schemaLocation": "https://json-schema.org/schemas/example#/properties/foo/allOf/1",
33393339
"instanceLocation": "/foo",
3340-
"nested": [
3340+
"details": [
33413341
{
33423342
"valid": false,
33433343
"evaluationPath": "/properties/foo/allOf/1/properties/foo-prop",
@@ -3362,13 +3362,13 @@ https://example.com/schemas/common#/$defs/allOf/1
33623362
"evaluationPath": "/properties/bar",
33633363
"schemaLocation": "https://json-schema.org/schemas/example#/properties/bar",
33643364
"instanceLocation": "/bar",
3365-
"nested": [
3365+
"details": [
33663366
{
33673367
"valid": false,
33683368
"evaluationPath": "/properties/bar/$ref",
33693369
"schemaLocation": "https://json-schema.org/schemas/example#/$defs/bar",
33703370
"instanceLocation": "/bar",
3371-
"nested": [
3371+
"details": [
33723372
{
33733373
"valid": false,
33743374
"evaluationPath": "/properties/bar/$ref/properties/bar-prop",
@@ -3398,13 +3398,13 @@ https://example.com/schemas/common#/$defs/allOf/1
33983398
"bar"
33993399
]
34003400
},
3401-
"nested": [
3401+
"details": [
34023402
{
34033403
"valid": true,
34043404
"evaluationPath": "/properties/foo",
34053405
"schemaLocation": "https://json-schema.org/schemas/example#/properties/foo",
34063406
"instanceLocation": "/foo",
3407-
"nested": [
3407+
"details": [
34083408
{
34093409
"valid": true,
34103410
"evaluationPath": "/properties/foo/allOf/0",
@@ -3425,7 +3425,7 @@ https://example.com/schemas/common#/$defs/allOf/1
34253425
"unspecified-prop"
34263426
]
34273427
},
3428-
"nested": [
3428+
"details": [
34293429
{
34303430
"valid": true,
34313431
"evaluationPath": "/properties/foo/allOf/1/properties/foo-prop",
@@ -3450,7 +3450,7 @@ https://example.com/schemas/common#/$defs/allOf/1
34503450
"evaluationPath": "/properties/bar",
34513451
"schemaLocation": "https://json-schema.org/schemas/example#/properties/bar",
34523452
"instanceLocation": "/bar",
3453-
"nested": [
3453+
"details": [
34543454
{
34553455
"valid": true,
34563456
"evaluationPath": "/properties/bar/$ref",
@@ -3462,7 +3462,7 @@ https://example.com/schemas/common#/$defs/allOf/1
34623462
"bar-prop"
34633463
]
34643464
},
3465-
"nested": [
3465+
"details": [
34663466
{
34673467
"valid": true,
34683468
"evaluationPath": "/properties/bar/$ref/properties/bar-prop",

0 commit comments

Comments
 (0)