Skip to content

Commit 10e8874

Browse files
jdesrosiersjdesrosiers
committed
Fixes for dynamic scope and keywords
1 parent 2c7d4bc commit 10e8874

File tree

1 file changed

+25
-46
lines changed

1 file changed

+25
-46
lines changed

‎jsonschema-core.xml

Lines changed: 25 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -654,25 +654,17 @@
654654
appear in a schema resource's root schema.
655655
</t>
656656
<t>
657-
Other keywords may take into account the dynamic scope that
658-
exists during the evaluation of a schema, typically together
659-
with an instance document. The outermost dynamic scope is the
660-
root schema of the schema document in which processing begins.
661-
The path from this root schema to any particular keyword (that
662-
includes any "$ref" and "$dynamicRef" keywords that may have
663-
been resolved) is considered the keyword's "validation path."
664-
<cref>
665-
Or should this be the schema object at which processing
666-
begins, even if it is not a root? This has some implications
667-
for the case where "$dynamicAnchor" is only allowed in the
668-
root schema but processing begins in a subschema.
669-
</cref>
657+
Other keywords may take into account the dynamic scope that exists during the
658+
evaluation of a schema. The outermost dynamic scope is the root schema of the
659+
schema document in which processing begins. The path from this root schema to
660+
any particular keyword (that includes any "$ref" and "$dynamicRef" keywords that
661+
may have been resolved) is considered the keyword's "validation path."
670662
</t>
671663
<t>
672664
Lexical and dynamic scopes align until a reference keyword
673665
is encountered. While following the reference keyword moves processing
674666
from one lexical scope into a different one, from the perspective
675-
of dynamic scope, following reference is no different from descending
667+
of dynamic scope, following a reference is no different from descending
676668
into a subschema present as a value. A keyword on the far side of
677669
that reference that resolves information through the dynamic scope
678670
will consider the originating side of the reference to be their
@@ -741,7 +733,7 @@
741733
<t>
742734
Canonical schema URIs MUST NOT change while processing an instance, but
743735
keywords that affect URI-reference resolution MAY have behavior that
744-
is only fully determined at runtime.
736+
is only fully determined dynamically.
745737
</t>
746738
<t>
747739
While custom identifier keywords are possible, vocabulary designers should
@@ -798,12 +790,10 @@
798790
of an instance against a schema.
799791
</t>
800792
<t>
801-
For some by-reference applicators, such as
802-
<xref target="ref">"$ref"</xref>, the referenced schema can be determined
803-
by static analysis of the schema document's lexical scope. Others,
804-
such as "$dynamicRef" (with "$dynamicAnchor"), may make use of dynamic
805-
scoping, and therefore only be resolvable in the process of evaluating
806-
the schema with an instance.
793+
For some by-reference applicators, such as <xref target="ref">"$ref"</xref>, the
794+
referenced schema can be determined by static analysis of the schema document's
795+
lexical scope. Others, such as "$dynamicRef" (with "$dynamicAnchor"), are only
796+
resolvable with knowledge of all the schemas in it's dynamic scope.
807797
</t>
808798
</section>
809799
</section>
@@ -1397,7 +1387,6 @@
13971387
The "$anchor" and "$dynamicAnchor" keywords are used to specify such
13981388
fragments. They are identifier keywords that can only be used to create
13991389
plain name fragments, rather than absolute URIs as seen with "$id".
1400-
The behavior of the created fragment is identical for both keywords.
14011390
</t>
14021391
<t>
14031392
The base URI to which the resulting fragment is appended is the canonical
@@ -1471,51 +1460,41 @@
14711460
</cref>
14721461
</t>
14731462
<t>
1474-
The value of the "$ref" property MUST be a string which is a URI-Reference.
1463+
The value of the "$ref" keyword MUST be a string which is a URI-Reference.
14751464
Resolved against the current URI base, it produces the URI of the schema
1476-
to apply. This resolution is safe to perform on schema load, as the
1477-
process of evaluating an instance cannot change how the reference resolves.
1465+
to apply. This resolution is safe to perform on schema load as neither other
1466+
schemas nor the instance can change how the reference resolves.
14781467
</t>
14791468
</section>
14801469

14811470
<section title='Dynamic References with "$dynamicRef"' anchor="dynamic-ref">
14821471
<t>
1483-
The "$dynamicRef" keyword is an applicator that allows for deferring the
1484-
full resolution until runtime, at which point it is resolved each time it is
1485-
encountered while evaluating an instance.
1472+
The "$dynamicRef" keyword is an applicator that is used to reference a
1473+
dynamically identified schema.
14861474
</t>
14871475
<t>
14881476
Together with "$dynamicAnchor", "$dynamicRef" implements a cooperative
14891477
extension mechanism that is primarily useful with recursive schemas
14901478
(schemas that reference themselves). Both the extension point and the
1491-
runtime-determined extension target are defined with "$dynamicAnchor",
1492-
and only exhibit runtime dynamic behavior when referenced with
1493-
"$dynamicRef".
1479+
extension target are defined with "$dynamicAnchor", and only exhibit dynamic
1480+
behavior when referenced with "$dynamicRef".
14941481
</t>
14951482
<t>
1496-
The value of the "$dynamicRef" property MUST be a string which is
1497-
a URI-Reference. Resolved against the current URI base, it produces
1498-
the URI used as the starting point for runtime resolution. This initial
1499-
resolution is safe to perform on schema load.
1483+
The value of the "$dynamicRef" property MUST be a string which is a
1484+
URI-Reference. Resolved against the current URI base, it produces the URI used
1485+
as the starting point for resolution. This initial resolution is safe to perform
1486+
on schema load.
15001487
</t>
15011488
<t>
15021489
If the initially resolved starting point URI includes a fragment that
15031490
was created by the "$dynamicAnchor" keyword, the initial URI MUST be
15041491
replaced by the URI (including the fragment) for the outermost schema
15051492
resource in the <xref target="scopes">dynamic scope</xref> that defines
15061493
an identically named fragment with "$dynamicAnchor".
1507-
<cref>
1508-
Requiring both the initial and final URI fragment to be defined
1509-
by "$dynamicAnchor" ensures that the more common "$anchor"
1510-
never unexpectedly changes the dynamic resolution process
1511-
due to a naming conflict across resources. Users of
1512-
"$dynamicAnchor" are expected to be aware of the possibility
1513-
of such name collisions, while users of "$anchor" are not.
1514-
</cref>
15151494
</t>
15161495
<t>
1517-
Otherwise, its behavior is identical to "$ref", and no runtime
1518-
resolution is needed.
1496+
Otherwise, its behavior is identical to "$ref", and no dynamic resolution is
1497+
needed.
15191498
</t>
15201499
<t>
15211500
For a full example using these keyword, see appendix
@@ -3503,7 +3482,7 @@ https://example.com/schemas/common#/$defs/count/minimum
35033482
{
35043483
"$schema": "https://json-schema.org/draft/2020-11/schema",
35053484
"$id": "https://example.com/strict-tree",
3506-
"$dynamicAnchor": node,
3485+
"$dynamicAnchor": "node",
35073486
35083487
"$ref": "tree",
35093488
"unevaluatedProperties": false

0 commit comments

Comments
 (0)