Skip to content

Commit 27338fe

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 b337ff3 commit 27338fe

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
@@ -1494,7 +1494,7 @@
14941494
</t>
14951495
<t>
14961496
Further examples of such non-canonical URIs, as well as the appropriate
1497-
canonical URIs to use instead, are provided in section
1497+
canonical URIs to use instead, are provided in appendix
14981498
<xref target="idExamples" format="counter"></xref>.
14991499
</t>
15001500
</section>
@@ -1831,7 +1831,7 @@
18311831
on the trust that the validator has in the schema. Such URIs and schemas
18321832
can be supplied to an implementation prior to processing instances, or may
18331833
be noted within a schema document as it is processed, producing associations
1834-
as shown in section <xref target="idExamples" format="counter"></xref>.
1834+
as shown in appendix <xref target="idExamples" format="counter"></xref>.
18351835
</t>
18361836
<t>
18371837
A schema MAY (and likely will) have multiple URIs, but there is no way for a
@@ -3330,8 +3330,7 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
33303330
Pointers</xref> (relative to the root schema) have the following
33313331
base URIs, and are identifiable by any listed URI in accordance with
33323332
sections <xref target="fragments" format="counter"></xref> and
3333-
<xref target="embedded" format="counter"></xref> above. As previously
3334-
noted, support for non-canonical URIs is OPTIONAL.
3333+
<xref target="embedded" format="counter"></xref> above.
33353334
</t>
33363335
<t>
33373336
<list style="hanging">
@@ -3418,7 +3417,7 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
34183417
<section title="Working with vocabularies">
34193418
<section title="Best practices for vocabulary and meta-schema authors">
34203419
<t>
3421-
Vocabulary authors SHOULD
3420+
Vocabulary authors should
34223421
take care to avoid keyword name collisions if the vocabulary is intended
34233422
for broad use, and potentially combined with other vocabularies. JSON
34243423
Schema does not provide any formal namespacing system, but also does
@@ -3431,25 +3430,25 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
34313430
vocabulary, or by using a keyword from another vocabulary with
34323431
a restricted or expanded set of acceptable values. Not all such
34333432
vocabulary re-use will result in a new vocabulary that is compatible
3434-
with the vocabulary on which it is built. Vocabulary authors SHOULD
3433+
with the vocabulary on which it is built. Vocabulary authors should
34353434
clearly document what level of compatibility, if any, is expected.
34363435
</t>
34373436
<t>
3438-
Meta-schema authors SHOULD NOT use "$vocabulary" to combine multiple
3437+
Meta-schema authors should not use "$vocabulary" to combine multiple
34393438
vocabularies that define conflicting syntax or semantics for the same
34403439
keyword. As semantic conflicts are not generally detectable through
34413440
schema validation, implementations are not expected to detect such
34423441
conflicts. If conflicting vocabularies are declared, the resulting
34433442
behavior is undefined.
34443443
</t>
34453444
<t>
3446-
Vocabulary authors SHOULD provide a meta-schema that validates the
3445+
Vocabulary authors should provide a meta-schema that validates the
34473446
expected usage of the vocabulary's keywords on their own. Such meta-schemas
3448-
SHOULD NOT forbid additional keywords, and MUST NOT forbid any
3447+
should not forbid additional keywords, and must not forbid any
34493448
keywords from the Core vocabulary.
34503449
</t>
34513450
<t>
3452-
It is RECOMMENDED that meta-schema authors reference each vocabulary's
3451+
It is recommended that meta-schema authors reference each vocabulary's
34533452
meta-schema using the <xref target="allOf">"allOf"</xref> keyword,
34543453
although other mechanisms for constructing the meta-schema may be
34553454
appropriate for certain use cases.
@@ -3461,14 +3460,14 @@ User-Agent: product-name/5.4.1 so-cool-json-schema/1.0.2 curl/7.43.0
34613460
which extends the Validation meta-schema.
34623461
</t>
34633462
<t>
3464-
Meta-schemas MAY impose additional constraints, including describing
3463+
Meta-schemas may impose additional constraints, including describing
34653464
keywords not present in any vocabulary, beyond what the meta-schemas
34663465
associated with the declared vocabularies describe. This allows for
34673466
restricting usage to a subset of a vocabulary, and for validating
34683467
locally defined keywords not intended for re-use.
34693468
</t>
34703469
<t>
3471-
However, meta-schemas SHOULD NOT contradict any vocabularies that
3470+
However, meta-schemas should not contradict any vocabularies that
34723471
they declare, such as by requiring a different JSON type than
34733472
the vocabulary expects. The resulting behavior is undefined.
34743473
</t>

0 commit comments

Comments
 (0)