Skip to content

Commit 71dd816

Browse files
committed
replace 'IRI' ABNF symbol references with plain language
1 parent 08943f7 commit 71dd816

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

jsonschema-core.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -452,8 +452,8 @@ The lexical scope of a keyword is determined by the nested JSON data structure
452452
of objects and arrays. The largest such scope is an entire schema document. The
453453
smallest scope is a single schema object with no subschemas.
454454

455-
Keywords MAY be defined with a partial value, such as a IRI-reference, which
456-
must be resolved against another value, such as another IRI-reference or a full
455+
Keywords MAY be defined with a partial value, such as a IRI reference, which
456+
must be resolved against another value, such as another IRI reference or a full
457457
IRI, which is found through the lexical structure of the JSON document. The
458458
`$id`, `$ref`, and `$dynamicRef` core keywords, and the "base" JSON Hyper-Schema
459459
keyword, are examples of this sort of behavior.
@@ -542,7 +542,7 @@ Identifiers define IRIs for a schema, or affect how such IRIs are resolved in
542542
keywords, most notably `$id`.
543543

544544
Canonical schema IRIs MUST NOT change while processing an instance, but keywords
545-
that affect IRI-reference resolution MAY have behavior that is only fully
545+
that affect IRI reference resolution MAY have behavior that is only fully
546546
determined at runtime.
547547

548548
While custom identifier keywords are possible, extension designers should take
@@ -898,8 +898,8 @@ To differentiate between schemas in a vast ecosystem, schemas are identified by
898898
[IRI](#rfc3987), and can embed references to other schemas by specifying their
899899
IRI.
900900

901-
Several keywords can accept a relative [IRI-reference](#rfc3987), or a value
902-
used to construct a relative IRI-reference. For these keywords, it is necessary
901+
Several keywords can accept a relative [IRI reference](#rfc3987), or a value
902+
used to construct a relative IRI reference. For these keywords, it is necessary
903903
to establish a base IRI in order to resolve the reference.
904904

905905
#### The `$id` Keyword {#id-keyword}
@@ -912,10 +912,10 @@ the case of a network-addressable URL, a schema need not be downloadable from
912912
its canonical IRI.
913913

914914
If present, the value for this keyword MUST be a string, and MUST represent a
915-
valid [IRI-reference](#rfc3987). This IRI-reference SHOULD be normalized, and
916-
MUST resolve to an [absolute-IRI](#rfc3987) (without a fragment).
915+
valid [IRI reference](#rfc3987). This IRI reference SHOULD be normalized, and
916+
MUST resolve to an [absolute IRI](#rfc3987) (without a fragment).
917917

918-
The resulting absolute-IRI serves as the base IRI for relative IRI-references in
918+
The resulting absolute IRI serves as the base IRI for relative IRI references in
919919
keywords within the schema resource, in accordance with [RFC 3987 section
920920
6.5](#rfc3987) and [RFC 3986 section 5.1.1](#rfc3986) regarding base IRIs
921921
embedded in content.
@@ -924,7 +924,7 @@ The presence of `$id` in a subschema indicates that the subschema constitutes a
924924
distinct schema resource within a single schema document. Furthermore, in
925925
accordance with [RFC 3987 section 6.5](#rfc3987) and [RFC 3986 section
926926
5.1.2](#rfc3986) regarding encapsulating entities, if an `$id` in a subschema is
927-
a relative IRI-reference, the base IRI for resolving that reference is the IRI
927+
a relative IRI reference, the base IRI for resolving that reference is the IRI
928928
of the parent schema resource. Note that an `$id` consisting of an empty IRI or
929929
of the empty fragment only will result in the embedded resource having the same
930930
IRI as the encapsulating resource, which SHOULD be considered an error per
@@ -937,7 +937,7 @@ given in the [previous section.](initial-base)
937937
##### Identifying the root schema
938938

939939
The root schema of a JSON Schema document SHOULD contain an `$id` keyword with
940-
an [absolute-IRI](#rfc3987) (containing a scheme, but no fragment).
940+
an [absolute IRI](#rfc3987) (containing a scheme, but no fragment).
941941

942942
#### Defining location-independent identifiers {#anchors}
943943

@@ -971,7 +971,7 @@ If present, the value of these keywords MUST be a string and MUST conform to the
971971
plain name fragment identifier syntax defined in {{fragments}}.[^4]
972972

973973
[^4]: Note that the anchor string does not include the "#" character, as it is
974-
not a IRI-reference. An `$anchor`: "foo" becomes the fragment `#foo` when used
974+
not a IRI reference. An `$anchor`: "foo" becomes the fragment `#foo` when used
975975
in a IRI. See below for full examples.
976976

977977
#### Duplicate schema identifiers {#duplicate-iris}
@@ -1005,7 +1005,7 @@ identified schema. Its results are the results of the referenced schema.[^5]
10051005
[^5]: Note that this definition of how the results are determined means that
10061006
other keywords can appear alongside of `$ref` in the same schema object.
10071007

1008-
The value of the `$ref` keyword MUST be a string which is a IRI-Reference.
1008+
The value of the `$ref` keyword MUST be a string which is a IRI reference.
10091009
Resolved against the current IRI base, it produces the IRI of the schema to
10101010
apply. This resolution is safe to perform on schema load, as the process of
10111011
evaluating an instance cannot change how the reference resolves.
@@ -1022,7 +1022,7 @@ reference themselves). The extension point is defined with `$dynamicAnchor` and
10221022
only exhibits runtime dynamic behavior when referenced with `$dynamicRef`.
10231023

10241024
The value of the `$dynamicRef` property MUST be a string which is a
1025-
IRI-Reference that contains a valid [plain name fragment](#anchors). Resolved
1025+
IRI reference that contains a valid [plain name fragment](#anchors). Resolved
10261026
against the current IRI base, it indicates the schema resource used as the
10271027
starting point for runtime resolution. This initial resolution is safe to
10281028
perform on schema load.
@@ -2284,9 +2284,9 @@ simplify coding so that various invocations of JSON Schema libraries do not have
22842284
to keep track of and load a large number of resources.
22852285

22862286
This transformation can be safely and reversibly done as long as all static
2287-
references (e.g. `$ref`) use IRI-references that resolve to IRIs using the
2287+
references (e.g. `$ref`) use IRI references that resolve to IRIs using the
22882288
canonical resource IRI as the base, and all schema resources have an
2289-
absolute-IRI as the `$id` in their root schema.
2289+
absolute IRI as the `$id` in their root schema.
22902290

22912291
With these conditions met, each external resource can be copied under `$defs`,
22922292
without breaking any references among the resources' schema objects, and without
@@ -2470,7 +2470,7 @@ to the document.
24702470
- Clarify that detecting duplicate IRIs for different schemas SHOULD raise an
24712471
error
24722472
- Consolidate and clarify the syntax and rationale for plain-name fragments
2473-
- "$id" MUST be an absolute-IRI, without any fragment, even an empty one
2473+
- "$id" MUST be an absolute IRI, without any fragment, even an empty one
24742474
- Note that an empty string "$id" results in duplicate IRIs for different
24752475
schemas
24762476
- Define empty schemas as empty (no longer allowing unrecognized keywords)

jsonschema-validation.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -444,7 +444,7 @@ representation of an IP address as follows:
444444
[RFC3986](#rfc3986).
445445
- *iri:* A string instance is valid against this attribute if it is a valid IRI,
446446
according to [RFC3987](#rfc3987).
447-
- *iri-reference:* A string instance is valid against this attribute if it is a
447+
- *IRI reference:* A string instance is valid against this attribute if it is a
448448
valid IRI Reference (either an IRI or a relative-reference), according to
449449
[RFC3987](#rfc3987).
450450
- *uuid:* A string instance is valid against this attribute if it is a valid
@@ -563,7 +563,7 @@ The value of this property MUST be a valid JSON schema. It SHOULD be ignored if
563563
location IRI included as part of the annotation will ensure that it is correctly
564564
processed as a subschema. Using the extracted annotation value directly is only
565565
safe if the schema is an embedded resource with both `$schema` and an
566-
absolute-IRI `$id`.
566+
absolute IRI `$id`.
567567

568568
### Example
569569

@@ -952,7 +952,7 @@ schema form to the core spec
952952
- Restored "regex" format (removal was unintentional)
953953
- Added "date" and "time" formats, and reserved additional RFC 3339 format
954954
names
955-
- I18N formats: "iri", "iri-reference", "idn-hostname", "idn-email"
955+
- I18N formats: "iri", "IRI reference", "idn-hostname", "idn-email"
956956
- Clarify that "json-pointer" format means string encoding, not URI fragment
957957
- Fixed typo that inverted the meaning of `minimum` and `exclusiveMinimum`
958958
- Move format syntax references into Normative References

0 commit comments

Comments
 (0)