Skip to content

Commit cb7861b

Browse files
committed
add droppedAnnotations
1 parent 9665007 commit cb7861b

File tree

1 file changed

+34
-5
lines changed

1 file changed

+34
-5
lines changed

jsonschema-core.xml

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2888,11 +2888,14 @@ https://example.com/schemas/common#/$defs/allOf/1
28882888

28892889
<section title="Annotations">
28902890
<t>
2891-
Any annotations produced by the validation. This property MUST NOT
2892-
be included if the validation was unsuccessful. The value
2893-
for this property MUST be an object where the keys are the names of
2894-
keywords and the values are the annotations produced by the
2895-
associated keyword.
2891+
Any annotations produced by the evaluation. This property MUST NOT
2892+
be included if the validation result of the containing subschema was
2893+
unsuccessful.
2894+
</t>
2895+
<t>
2896+
The value for this property MUST be an object where the
2897+
keys are the names of keywords and the values are the annotations
2898+
produced by the associated keyword.
28962899
</t>
28972900
<t>
28982901
Each keyword defines its own annotation data type (e.g. "properties"
@@ -2903,6 +2906,32 @@ https://example.com/schemas/common#/$defs/allOf/1
29032906
</t>
29042907
</section>
29052908

2909+
<section title="Dropped Annotations">
2910+
<t>
2911+
Any annotations produced and subsequently dropped by the evaluation
2912+
due to an unsuccessful validation result of the containing subschema.
2913+
This property MAY be included if the validation result of the containing
2914+
subschema was unsuccessful. It MUST NOT be included if the local
2915+
validation result of the containing subschema was successful.
2916+
</t>
2917+
<t>
2918+
Implementations that wish to include these annotations are encouraged
2919+
to provide users with a configuration option to exclude them.
2920+
</t>
2921+
<t>
2922+
The value for this property MUST be an object where the
2923+
keys are the names of keywords and the values are the annotations
2924+
produced by the associated keyword.
2925+
</t>
2926+
<t>
2927+
Each keyword defines its own annotation data type (e.g. "properties"
2928+
produces a list of keywords, whereas "title" produces a string).
2929+
</t>
2930+
<t>
2931+
The JSON key for this information is "droppedAnnotations".
2932+
</t>
2933+
</section>
2934+
29062935
<section title="Nested Results">
29072936
<t>
29082937
Nested results are generated from keywords which create a new dynamic

0 commit comments

Comments
 (0)