Skip to content

Commit 332abe6

Browse files
committed
Remove RFC 2119 language from examples/guidance
Vocabulary authorship is not part of the JSON Schema specification, so this guidance should not use RFC 2119 terms.
1 parent c8017f8 commit 332abe6

File tree

1 file changed

+11
-12
lines changed

1 file changed

+11
-12
lines changed

jsonschema-core.xml

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1502,7 +1502,7 @@
15021502
</t>
15031503
<t>
15041504
Further examples of such non-canonical URIs, as well as the appropriate
1505-
canonical URIs to use instead, are provided in section
1505+
canonical URIs to use instead, are provided in appendix
15061506
<xref target="idExamples" format="counter"></xref>.
15071507
</t>
15081508
</section>
@@ -1839,7 +1839,7 @@
18391839
on the trust that the validator has in the schema. Such URIs and schemas
18401840
can be supplied to an implementation prior to processing instances, or may
18411841
be noted within a schema document as it is processed, producing associations
1842-
as shown in section <xref target="idExamples" format="counter"></xref>.
1842+
as shown in appendix <xref target="idExamples" format="counter"></xref>.
18431843
</t>
18441844
<t>
18451845
A schema MAY (and likely will) have multiple URIs, but there is no way for a
@@ -3351,8 +3351,7 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
33513351
Pointers</xref> (relative to the root schema) have the following
33523352
base URIs, and are identifiable by any listed URI in accordance with
33533353
sections <xref target="fragments" format="counter"></xref> and
3354-
<xref target="embedded" format="counter"></xref> above. As previously
3355-
noted, support for non-canonical URIs is OPTIONAL.
3354+
<xref target="embedded" format="counter"></xref> above.
33563355
</t>
33573356
<t>
33583357
<list style="hanging">
@@ -3439,7 +3438,7 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
34393438
<section title="Working with vocabularies">
34403439
<section title="Best practices for vocabulary and meta-schema authors">
34413440
<t>
3442-
Vocabulary authors SHOULD
3441+
Vocabulary authors should
34433442
take care to avoid keyword name collisions if the vocabulary is intended
34443443
for broad use, and potentially combined with other vocabularies. JSON
34453444
Schema does not provide any formal namespacing system, but also does
@@ -3452,25 +3451,25 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
34523451
vocabulary, or by using a keyword from another vocabulary with
34533452
a restricted or expanded set of acceptable values. Not all such
34543453
vocabulary re-use will result in a new vocabulary that is compatible
3455-
with the vocabulary on which it is built. Vocabulary authors SHOULD
3454+
with the vocabulary on which it is built. Vocabulary authors should
34563455
clearly document what level of compatibility, if any, is expected.
34573456
</t>
34583457
<t>
3459-
Meta-schema authors SHOULD NOT use "$vocabulary" to combine multiple
3458+
Meta-schema authors should not use "$vocabulary" to combine multiple
34603459
vocabularies that define conflicting syntax or semantics for the same
34613460
keyword. As semantic conflicts are not generally detectable through
34623461
schema validation, implementations are not expected to detect such
34633462
conflicts. If conflicting vocabularies are declared, the resulting
34643463
behavior is undefined.
34653464
</t>
34663465
<t>
3467-
Vocabulary authors SHOULD provide a meta-schema that validates the
3466+
Vocabulary authors should provide a meta-schema that validates the
34683467
expected usage of the vocabulary's keywords on their own. Such meta-schemas
3469-
SHOULD NOT forbid additional keywords, and MUST NOT forbid any
3468+
should not forbid additional keywords, and must not forbid any
34703469
keywords from the Core vocabulary.
34713470
</t>
34723471
<t>
3473-
It is RECOMMENDED that meta-schema authors reference each vocabulary's
3472+
It is recommended that meta-schema authors reference each vocabulary's
34743473
meta-schema using the <xref target="allOf">"allOf"</xref> keyword,
34753474
although other mechanisms for constructing the meta-schema may be
34763475
appropriate for certain use cases.
@@ -3482,14 +3481,14 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
34823481
which extends the Validation meta-schema.
34833482
</t>
34843483
<t>
3485-
Meta-schemas MAY impose additional constraints, including describing
3484+
Meta-schemas may impose additional constraints, including describing
34863485
keywords not present in any vocabulary, beyond what the meta-schemas
34873486
associated with the declared vocabularies describe. This allows for
34883487
restricting usage to a subset of a vocabulary, and for validating
34893488
locally defined keywords not intended for re-use.
34903489
</t>
34913490
<t>
3492-
However, meta-schemas SHOULD NOT contradict any vocabularies that
3491+
However, meta-schemas should not contradict any vocabularies that
34933492
they declare, such as by requiring a different JSON type than
34943493
the vocabulary expects. The resulting behavior is undefined.
34953494
</t>

0 commit comments

Comments
 (0)