Skip to content

Commit c186b9a

Browse files
committed
Add CREF about ambiguous behaviour of additionalProperties
Fixes #1172 Must see new issue relating to the behaviour of annotation collection for resolving in the next draft.
1 parent afca53d commit c186b9a

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

jsonschema-core.xml

+22
Original file line numberDiff line numberDiff line change
@@ -2480,6 +2480,28 @@
24802480
checking the names in "properties" and the patterns in
24812481
"patternProperties" against the instance property set.
24822482
Implementations that do not support annotation collection MUST do so.
2483+
<cref>
2484+
In defining this option, it seems there is the potential for
2485+
ambiguity in the output format. The ambiguity does not affect validation results,
2486+
but it does affect the resulting output format.
2487+
The ambiguity allows for multiple valid output results depending on whether annotations
2488+
are used or a solution that "produces the same effect" as draft-07. It is understood
2489+
that annotations from failing schemas are dropped. See
2490+
https://github.com/json-schema-org/community/discussions/57 for details.
2491+
We discussed the possible solutions at length (https://github.com/json-schema-org/json-schema-spec/issues/1172).
2492+
We concluded that we need to re-evaluate the annotation collection system
2493+
and its use for validation purposes, but we also agreed not to do so for this release.
2494+
This confusion stemmed from the understanding of "evaluated" and the impact on
2495+
annotation collection.
2496+
It was proposed that we could read a different interpretation (https://github.com/json-schema-org/json-schema-spec/issues/1172#issuecomment-1049686478)
2497+
however the previous interpretation is still valid.
2498+
The only consensus we could reach for this release was to note all this
2499+
in a CREF, which you're now reading, and acknowledge that both results
2500+
as described in https://github.com/json-schema-org/community/discussions/57.
2501+
If you encounter the same issue regarding ambiguity of the output format,
2502+
please do reach out to us, either via emails as per editors of this specification,
2503+
or other official JSON Schema channels like our Slack or Twitter.
2504+
</cref>
24832505
</t>
24842506
</section>
24852507

0 commit comments

Comments
 (0)