Skip to content

Commit 509ed28

Browse files
committed
more verbiage tweaks to output
1 parent fe67355 commit 509ed28

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

jsonschema-core.xml

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2727,7 +2727,8 @@
27272727
</t>
27282728
<t>
27292729
Hierarchical - Provides validation information in a hierarchical
2730-
structure that mimics the dereferenced evaluation structure of the schema.
2730+
structure that follows the evaluation paths generated while processing
2731+
the schema.
27312732
</t>
27322733
</list>
27332734
An implementation MUST provide the "flag" format and SHOULD provide at least one
@@ -2753,10 +2754,9 @@
27532754

27542755
<section title="Evaluation path">
27552756
<t>
2756-
The location of the schema resource that produced the output unit, represented
2757-
by the path traversed during evaluation. The value MUST be expressed as a
2758-
JSON Pointer, and it MUST include any by-reference applicators such as
2759-
"$ref" or "$dynamicRef".
2757+
The evalutaion path to the schema object that produced the output unit.
2758+
The value MUST be expressed as a JSON Pointer, and it MUST include any
2759+
by-reference applicators such as "$ref" or "$dynamicRef".
27602760
<cref>
27612761
The schema may not actually have a value at the location indicated
27622762
by this pointer. It is provided as an indication of the traversal
@@ -2779,19 +2779,19 @@
27792779
</t>
27802780
</section>
27812781

2782-
<section title="Subschema Location">
2782+
<section title="Schema Location">
27832783
<t>
2784-
The absolute, dereferenced location of the schema resource that produced
2784+
The absolute, dereferenced location of the schema object that produced
27852785
the output unit. The value MUST be expressed using the canonical IRI of the
2786-
relevant schema resource plus a JSON Pointer fragment that indicates the contained
2787-
subschema that produced the output. It MUST NOT include by-reference applicators
2786+
relevant schema resource plus a JSON Pointer fragment that indicates the schema
2787+
object that produced the output. It MUST NOT include by-reference applicators
27882788
such as "$ref" or "$dynamicRef".
27892789
<cref>
27902790
Note that "absolute" here is in the sense of "absolute filesystem path"
27912791
(meaning the complete location) rather than the "absolute-IRI"
2792-
terminology from RFC 3987 (meaning with scheme but without fragment).
2793-
Keyword absolute locations will have a fragment in order to
2794-
identify the keyword.
2792+
terminology from RFC 3987 (meaning with scheme and without fragment).
2793+
Schema locations will have a fragment in order to identify the specific
2794+
schema object.
27952795
</cref>
27962796
</t>
27972797
<figure>
@@ -2844,7 +2844,7 @@ https://example.com/schemas/common#/$defs/count/minimum
28442844
</t>
28452845
<t>
28462846
Each keyword defines its own annotation data type (e.g. "properties"
2847-
produces a list of keywords, whereas "$title" produces a string).
2847+
produces a list of keywords, whereas "title" produces a string).
28482848
</t>
28492849
<t>
28502850
The JSON key for this information is "annotations".
@@ -2887,11 +2887,10 @@ https://example.com/schemas/common#/$defs/count/minimum
28872887
"nested" as described below.
28882888
<list>
28892889
<t>
2890-
"valid" - a boolean value indicating the overall validation success or
2891-
failure
2890+
"valid" - a boolean value indicating the overall validation success or failure
28922891
</t>
28932892
<t>
2894-
"nested" - the collection of errors or annotations produced by a subschema
2893+
"nested" - the collection of results produced by subschemas
28952894
</t>
28962895
</list>
28972896
For these examples, the following schema and instances will be used.
@@ -2963,21 +2962,21 @@ https://example.com/schemas/common#/$defs/count/minimum
29632962
<list>
29642963
<t>
29652964
The value at "/foo"
2966-
validated at "/properties/foo/allOf/0"
2965+
evaluated at "/properties/foo/allOf/0"
29672966
by following the path "/properties/foo/allOf/0"
29682967
by the "required" keyword
29692968
is missing the property "unspecified-prop".
29702969
</t>
29712970
<t>
29722971
The value at "/foo/foo-prop"
2973-
validated at "/properties/foo/allOf/1/properties/foo-prop"
2972+
evaluated at "/properties/foo/allOf/1/properties/foo-prop"
29742973
by following the path "/properties/foo/allOf/1/properties/foo-prop"
29752974
by the "const" keyword
29762975
is not the constant value 1.
29772976
</t>
29782977
<t>
29792978
The value at "/bar/bar-prop"
2980-
validated at "/$defs/bar/properties/bar-prop"
2979+
evaluated at "/$defs/bar/properties/bar-prop"
29812980
by following the path "/properties/bar/$ref/properties/bar-prop"
29822981
by the "type" keyword
29832982
is not a number.
@@ -2999,55 +2998,55 @@ https://example.com/schemas/common#/$defs/count/minimum
29992998
<list>
30002999
<t>
30013000
The keyword "title"
3002-
validated at ""
3001+
evaluated at ""
30033002
by following the path ""
30043003
will produce <sourcecode>"root"</sourcecode>.
30053004
</t>
30063005
<t>
30073006
The keyword "properties"
3008-
validated at ""
3007+
evaluated at ""
30093008
by following the path ""
30103009
will produce <sourcecode>["foo", "bar"]</sourcecode>.
30113010
</t>
30123011
<t>
30133012
The keyword "title"
3014-
validated at "/properties/foo"
3013+
evaluated at "/properties/foo"
30153014
by following the path "/properties/foo"
30163015
will produce <sourcecode>"foo-title"</sourcecode>.
30173016
</t>
30183017
<t>
30193018
The keyword "properties"
3020-
validated at "/properties/foo/allOf/1"
3019+
evaluated at "/properties/foo/allOf/1"
30213020
by following the path "/properties/foo/allOf/1"
30223021
will produce <sourcecode>["foo-prop"]</sourcecode>.
30233022
</t>
30243023
<t>
30253024
The keyword "additionalProperties"
3026-
validated at "/properties/foo/allOf/1"
3025+
evaluated at "/properties/foo/allOf/1"
30273026
by following the path "/properties/foo/allOf/1"
30283027
will produce <sourcecode>["unspecified-prop"]</sourcecode>.
30293028
</t>
30303029
<t>
30313030
The keyword "title"
3032-
validated at "/properties/foo/allOf/1/properties/foo-prop"
3031+
evaluated at "/properties/foo/allOf/1/properties/foo-prop"
30333032
by following the path "/properties/foo/allOf/1/properties/foo-prop"
30343033
will produce <sourcecode>"foo-prop-title"</sourcecode>.
30353034
</t>
30363035
<t>
30373036
The keyword "title"
3038-
validated at "/$defs/bar"
3037+
evaluated at "/$defs/bar"
30393038
by following the path "/properties/bar/$ref"
30403039
will produce <sourcecode>"bar-title"</sourcecode>.
30413040
</t>
30423041
<t>
30433042
The keyword "properties"
3044-
validated at "/$defs/bar"
3043+
evaluated at "/$defs/bar"
30453044
by following the path "/properties/var/$ref"
30463045
will produce <sourcecode>["bar-prop"]</sourcecode>.
30473046
</t>
30483047
<t>
30493048
The keyword "title"
3050-
validated at "/$defs/bar/properties/bar-prop"
3049+
evaluated at "/$defs/bar/properties/bar-prop"
30513050
by following the path "/properties/bar/$ref/properties/bar-prop"
30523051
will produce <sourcecode>"bar-prop-title"</sourcecode>.
30533052
</t>
@@ -3206,7 +3205,7 @@ https://example.com/schemas/common#/$defs/count/minimum
32063205
<t>
32073206
The "Hierarchical" structure is a tree structure that follows the
32083207
evaluation path during the validation process. Typically, it will
3209-
resemble the schema as if all referenced schemas were bundled in place
3208+
resemble the schema as if all referenced schemas were inlined in place
32103209
of their associated by-reference keywords.
32113210
</t>
32123211
<t>

0 commit comments

Comments
 (0)