Skip to content

Commit 9e38f04

Browse files
gregsdennisjdesrosiers
authored andcommitted
output - change property names in declarations
1 parent dca1d11 commit 9e38f04

File tree

1 file changed

+15
-17
lines changed

1 file changed

+15
-17
lines changed

jsonschema-core.xml

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2759,9 +2759,10 @@
27592759

27602760
<section title="Keyword Relative Location">
27612761
<t>
2762-
The relative location of the validating keyword that follows the validation
2763-
path. The value MUST be expressed as a JSON Pointer, and it MUST include
2764-
any by-reference applicators such as "$ref" or "$dynamicRef".
2762+
The relative location of the validating keyword that follows the path
2763+
traversed through the schema. The value MUST be expressed as a JSON
2764+
Pointer, and it MUST include any by-reference applicators such as
2765+
"$ref" or "$dynamicRef".
27652766
</t>
27662767
<figure>
27672768
<artwork>
@@ -2775,7 +2776,7 @@
27752776
due to the inclusion of these by-reference applicator keywords.
27762777
</t>
27772778
<t>
2778-
The JSON key for this information is "keywordLocation".
2779+
The JSON key for this information is "evaluationPath".
27792780
</t>
27802781
</section>
27812782

@@ -2807,7 +2808,7 @@ https://example.com/schemas/common#/$defs/count/minimum
28072808
over a reference or if the schema does not declare an absolute IRI as its "$id".
28082809
</t>
28092810
<t>
2810-
The JSON key for this information is "absoluteKeywordLocation".
2811+
The JSON key for this information is "schemaLocation".
28112812
</t>
28122813
</section>
28132814

@@ -2841,13 +2842,15 @@ https://example.com/schemas/common#/$defs/count/minimum
28412842

28422843
<section title="Nested Results">
28432844
<t>
2844-
For the two hierarchical structures, this property will hold nested errors
2845-
and annotations.
2845+
For "basic", this property will appear only at the root node and will hold
2846+
all errors or annotations in a list.
28462847
</t>
28472848
<t>
2848-
The JSON key for nested results in failed validations is "errors"; for
2849-
successful validations it is "annotations". Note the plural forms, as
2850-
a keyword with nested results can also have a local error or annotation.
2849+
For "detailed" and "verbose", this property will hold nested errors
2850+
and annotations in a tree structure, mimicking that of the schema.
2851+
</t>
2852+
<t>
2853+
The JSON key for nested results is "nested".
28512854
</t>
28522855
</section>
28532856

@@ -2857,19 +2860,14 @@ https://example.com/schemas/common#/$defs/count/minimum
28572860
<t>
28582861
The output MUST be an object containing a boolean property named "valid". When
28592862
additional information about the result is required, the output MUST also contain
2860-
"errors" or "annotations" as described below.
2863+
"nested" as described below.
28612864
<list>
28622865
<t>
28632866
"valid" - a boolean value indicating the overall validation success or
28642867
failure
28652868
</t>
28662869
<t>
2867-
"errors" - the collection of errors or annotations produced by a failed
2868-
validation
2869-
</t>
2870-
<t>
2871-
"annotations" - the collection of errors or annotations produced by a
2872-
successful validation
2870+
"nested" - the collection of errors or annotations produced by a keyword
28732871
</t>
28742872
</list>
28752873
For these examples, the following schema and instance will be used.

0 commit comments

Comments
 (0)