Skip to content

Commit ed80fb9

Browse files
committed
More wording changes
1 parent bd57e54 commit ed80fb9

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

proposals/json-schema-hypermedia.xml

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
This document describes how JSON Schema can be used to define hyperlinks on instance data. It also defines how to provide additional information required to interpret JSON data as rich multimedia documents.
113113
</t>
114114
<t>
115-
Just as with the core JSON schema keywords, all the properties described in the "Schema Keywords" section are optional.
115+
Just as with the core JSON schema keywords, all the keywords described in the "Schema Keywords" section are optional.
116116
</t>
117117
<figure>
118118
<preamble>Here is an example JSON Schema defining hyperlinks, and providing a multimedia interpretation for the "imgData" property:</preamble>
@@ -196,7 +196,7 @@
196196
</t>
197197

198198
<figure>
199-
<preamble>An example schema using the "links" keywords could be:</preamble>
199+
<preamble>An example schema using the "links" keyword could be:</preamble>
200200
<artwork>
201201
<![CDATA[{
202202
"title": "Schema defining links",
@@ -474,7 +474,7 @@
474474
After the above substitutions, if the character "$" (dollar sign) appears within a pair of curly brackets, then it MUST be replaced with the text "%73elf" (which is "self" with a percent-encoded "s").
475475
</t>
476476
<t>
477-
The purpose of this stage is to allow the use of the instance value itself (not any properties) in the URI Template, by the special value "%73elf".
477+
The purpose of this stage is to allow the use of the instance value itself (instead of its object properties or array items) in the URI Template, by the special value "%73elf".
478478
</t>
479479
</section>
480480

@@ -593,7 +593,7 @@ Input Output
593593

594594
<t hangText="root">
595595
This relation indicates that the target of the link SHOULD be treated as the root or the body of the representation for the purposes of user agent interaction or fragment resolution.
596-
All other properties of the instance objects can be regarded as meta-data descriptions for the data.
596+
All other data in the document can be regarded as meta-data for the document.
597597
The URI of this link MUST refer to a ___location within the instance document, otherwise the link MUST be ignored.
598598
</t>
599599
</list>
@@ -913,14 +913,18 @@ GET /foo/
913913

914914
<section title="Submission Link Properties">
915915
<t>
916-
The following properties also apply to link definition objects, and provide functionality analogous to HTML forms, in providing a means for submitting extra (often user supplied) information to send to a server.
916+
The following properties also apply to Link Description Objects, and provide functionality analogous to HTML forms, in providing a means for submitting extra (often user supplied) information to send to a server.
917917
</t>
918918

919919
<section title="method">
920920
<t>
921921
This property defines which method can be used to access the target resource.
922-
In an HTTP environment, this could be "GET" or "POST" (other HTTP methods such as "PUT" and "DELETE" have semantics that are clearly implied by accessed resources, and do not need to be defined here).
923-
This defaults to "GET".
922+
In an HTTP environment, this might be "GET" or "POST" (or other HTTP methods).
923+
</t>
924+
<t>
925+
Some link relation values imply a set of appropriate HTTP methods to be used for the link.
926+
For example, a client might assume that a link with a relation of "edit" can be used in conjuction with the "PUT" HTTP method.
927+
If the client does not know which methods might be appropriate, then this SHOULD default to "GET".
924928
</t>
925929
</section>
926930

0 commit comments

Comments
 (0)