Skip to content

Commit 6bf4061

Browse files
committed
Standardize on "user agent data"
Instead of "user input", "client data", and "external data".
1 parent 323611b commit 6bf4061

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

jsonschema-hyperschema.xml

+16-16
Original file line numberDiff line numberDiff line change
@@ -399,7 +399,7 @@
399399
There are several ways that a client can use data can with a link:
400400
<list>
401401
<t> URI Template variables resolved from server-supplied instance data </t>
402-
<t> URI Template variables resolved from client data </t>
402+
<t> URI Template variables resolved from user agent data </t>
403403
<t> Replacing or modifying the target resource's representation </t>
404404
<t> Submitting data for processing, where the data has no
405405
inherent relation to the target resource's representation</t>
@@ -423,17 +423,17 @@
423423
<xref target="hrefSchema">"hrefSchema"</xref> allows a link to specify
424424
a schema for resolving template variables from client-supplied data.
425425
Regular JSON Schema validation features can be used to require resolution
426-
from client data, forbid it, or allow client data while falling back to
427-
server-supplied instance data if no client data is provided.
426+
from user agent data, forbid it, or allow user agent data while falling back to
427+
server-supplied instance data if no user agent data is provided.
428428
</t>
429429
<t>
430430
The common pattern of resolving a templated path component with
431-
server-supplied instance data while accepting client data to build
431+
server-supplied instance data while accepting user agent data to build
432432
a query string can be implemented by setting the "hrefSchema" subschemas
433433
for the path template variables to false, while giving the query string
434434
template variables names that do not appear in the instance. This ensures
435435
that the path variables can only be resolved from the instance, and the
436-
query string variables can only be resolved from client data.
436+
query string variables can only be resolved from user agent data.
437437
See the "hrefSchema" section for an example of this approach.
438438
</t>
439439
</section>
@@ -491,7 +491,7 @@
491491
<section title="Values for substitution">
492492
<t>
493493
The URI Template is filled out using data from some combination of an external source and the instance.
494-
Where either instance data or external data may be used, this section will refer simply to "data" or to a "value".
494+
Where either instance data or user agent data may be used, this section will refer simply to "data" or to a "value".
495495
When the source is important, it is specified explicitly.
496496

497497
To allow the use of any object property (including the empty string) or array index, the following rules are defined:
@@ -507,10 +507,10 @@
507507

508508
<t>
509509
If <xref target="hrefSchema">"hrefSchema"</xref> is present and
510-
external input is provided, the input MUST be a valid instance according
510+
user agent data is provided, the data MUST be a valid instance according
511511
to the value of "hrefSchema".
512512
Template variables, after the process listed above, MUST first
513-
be resolved from the external data instance. Any variables left
513+
be resolved from the user agent data instance. Any variables left
514514
unresolved MUST be resolved from the resource instance data.
515515
</t>
516516

@@ -533,11 +533,11 @@
533533
<section title="Missing values">
534534
<t>
535535
Sometimes, the appropriate values will not be available.
536-
For example, the template might specify the use of object properties, but no such input was provide (or "hrefSchema" is not present), and the instance is an array or a string.
536+
For example, the template might specify the use of object properties, but no such data was provided (or "hrefSchema" is not present), and the instance is an array or a string.
537537
</t>
538538

539539
<t>
540-
If any of the values required for the template are present in neither the user input (if relevant) or the JSON instance, then substitute values MAY be provided from another source (such as default values).
540+
If any of the values required for the template are neither present in the user agent data (if relevant) nor the JSON instance, then substitute values MAY be provided from another source (such as default values).
541541
Otherwise, the link definition SHOULD be considered not to apply to the instance.
542542
</t>
543543
</section>
@@ -549,17 +549,17 @@
549549
<t>
550550
The value of the "hrefSchema" link description property MUST be
551551
a valid JSON Schema. This schema is used to validate user input
552-
or other external data for filling out the URI Template in
552+
or other user agent data for filling out the URI Template in
553553
<xref target="href">"href"</xref>, as described in that section.
554554
</t>
555555
<t>
556556
Omitting "hrefSchema" or setting the entire schema to "false" prevents
557-
any external data from being accepted.
557+
any user agent data from being accepted.
558558
</t>
559559
<t>
560560
Implementations MUST NOT attempt to validate values resolved from
561561
resource instance data with "hrefSchema". This allows for different
562-
validation rules for user input, such as supporting spelled-out
562+
validation rules for user agent data, such as supporting spelled-out
563563
months for date-time input but using the standard date-time
564564
format for storage.
565565
</t>
@@ -593,9 +593,9 @@
593593
<figure>
594594
<preamble>
595595
In this example, the schema for "extra" is given as a reference
596-
to keep the external data validation constraints identical to the
596+
to keep the user agent data validation constraints identical to the
597597
instance validation constraints for the corresponding property,
598-
while "id" is given a false schema to prevent external data for
598+
while "id" is given a false schema to prevent user agent data for
599599
that variable.
600600
</preamble>
601601
<artwork>
@@ -984,7 +984,7 @@ GET /foo/
984984
</t>
985985
<t>
986986
Omitting "submissionSchema" or setting the entire schema to "false" prevents
987-
any external data from being accepted.
987+
any user agent data from being accepted.
988988
</t>
989989
</section>
990990
</section>

0 commit comments

Comments
 (0)