Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 782b28c

Browse files
committed
Wording improvements around HTTP usage.
1 parent e79dfd0 commit 782b28c

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

‎jsonschema-hyperschema.xml‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1251,7 +1251,9 @@ for varname in templateData:
12511251
</t>
12521252
<t>
12531253
All information necessary to use each HTTP method can be conveyed in a
1254-
single LDO as explained in this appendix.
1254+
single LDO as explained in this section. The "allow" field in "targetHints"
1255+
is intended simply to hint at which operations are supported, not to
1256+
separately define each operation.
12551257
</t>
12561258
<t>
12571259
Note, however, that a resource may always decline an operation at runtime,
@@ -1264,23 +1266,27 @@ for varname in templateData:
12641266
The relationship between a resource's representation and HTTP requests and
12651267
responses is determined by <xref target="RFC7231">RFC 7231, section 4.3.1 -
12661268
"GET", section 4.3.4 "PUT", and section 3.1.4.2, "Content-Location"</xref>.
1267-
In particular, "targetSchema" suggests what a
1268-
client can expect for the response to an HTTP GET or any response for which
1269-
the "Content-Location" header is equal to the request URI, and what a client
1270-
should send if it replaces the resource in an HTTP PUT request.
1269+
In particular, "targetSchema" suggests what a client can expect for the
1270+
response to an HTTP GET or any response for which the "Content-Location"
1271+
header is equal to the request URI, and what a client should send if it
1272+
replaces the resource in an HTTP PUT request.
12711273
</t>
12721274
<t>
12731275
The media type of the representation is given by the "targetMediaType"
12741276
field. Alternatively, possible available media types MAY be advertised
1275-
using an entry for the "Accept" request header field in "headerSchema".
1277+
for HTTP-accessible resources using the "accept" field in "headerSchema",
1278+
corresponding to the HTTP "Accept" header.
12761279
</t>
12771280
<t>
12781281
Per <xref target="RFC5789">RFC 5789</xref>, the request structure for an HTTP
12791282
PATCH is determined by the combination of "targetSchema" and the request
1280-
media type, which is conveyed by the "Accept-Patch" header.
1283+
media type, which is conveyed by the "Accept-Patch" header. Media types
1284+
that are suitable for PATCH-ing define a syntax for expressing changes
1285+
to a document, which can be applied to the representation described by
1286+
"targetSchema" to determine the set of syntactically valid request payloads.
12811287
</t>
12821288
<t>
1283-
HTTP POST requests are determined by the "submissionSchema" and
1289+
HTTP POST request payloads are described by the "submissionSchema" and
12841290
"submissionMediaType" fields. Additionally, the "Accept-Post" header
12851291
can be used to specify the necessary media type, and MAY be
12861292
advertised via the "targetHints" field.
@@ -1350,7 +1356,9 @@ for varname in templateData:
13501356
<t>
13511357
When using HTTP, or a protocol such as CoAP that is explicitly analogous
13521358
to HTTP, this is done by POST-ing a representation of the individual
1353-
resource to be created to the collection resource.
1359+
resource to be created to the collection resource. The process for
1360+
recognizing collection and item resources is described in
1361+
<xref target="collectionAndItem" />.
13541362
</t>
13551363
</section>
13561364
</section>

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /