Skip to content

Commit 4db5ea1

Browse files
authored
Merge pull request fcrepo#78 from Rarian/http_verbs
Standardize formatting of HTTP verbs
2 parents c0348a2 + 2f0179a commit 4db5ea1

File tree

1 file changed

+47
-47
lines changed

1 file changed

+47
-47
lines changed

index.html

+47-47
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@
112112
<p>
113113
A conforming <b>Fedora server</b> is a conforming [[!LDP]] 1.0 server except where described in this document
114114
that also follows the rules defined by Fedora in <a href="#resource-management"></a>,
115-
<a href="#resource-versioning"></a>, <a href="#binary-fixity"></a>, <a href="#resource-authorization"></a>,
115+
<a href="#resource-versioning"></a>, <a href="#binary-fixity"></a>, <a href="#resource-authorization"></a>,
116116
<a href="#atomic-operations"></a>, and <a href="#messaging"></a>.
117117
</p>
118118
</section>
@@ -124,17 +124,17 @@ <h2>Terminology</h2>
124124
<dt><dfn>LDPR</dfn>:</dt>
125125
<dd>
126126
A Linked Data Platform Resource as defined in [<a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-resource">LDP</a>].
127-
This may be an <a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-rdf-source">LDP RDF Source</a> (<a>LDP-RS</a>) or an
127+
This may be an <a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-rdf-source">LDP RDF Source</a> (<a>LDP-RS</a>) or an
128128
<a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-non-rdf-source">LDP Non-RDF Source</a> (<a>LDP-NR</a>).
129129
</dd>
130130
<dt><dfn>LDP-RS</dfn>:</dt>
131131
<dd>
132-
An <a>LDPR</a> whose state is fully represented in RDF as defined in
132+
An <a>LDPR</a> whose state is fully represented in RDF as defined in
133133
[<a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-rdf-source">LDP</a>].
134134
</dd>
135135
<dt><dfn>LDP-NR</dfn>:</dt>
136136
<dd>
137-
An <a>LDPR</a> whose state is not represented in RDF as defined in
137+
An <a>LDPR</a> whose state is not represented in RDF as defined in
138138
[<a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-non-rdf-source">LDP</a>].
139139
</dd>
140140
<dt><dfn>LDPRv</dfn>:</dt>
@@ -147,7 +147,7 @@ <h2>Terminology</h2>
147147
</dd>
148148
<dt><dfn>LDPC</dfn>:</dt>
149149
<dd>
150-
A collection of linked documents or information resources as defined in
150+
A collection of linked documents or information resources as defined in
151151
[<a href="https://www.w3.org/TR/ldp/#dfn-linked-data-platform-container">LDP</a>].
152152
</dd>
153153
<dt><dfn>LDPCv</dfn>:</dt>
@@ -175,7 +175,7 @@ <h2>Terminology</h2>
175175
</dd>
176176
<dt><dfn>TimeMap</dfn>:</dt>
177177
<dd>
178-
A type of resource defined in [<a href="https://tools.ietf.org/html/rfc7089#section-1.1">Memento</a>] that
178+
A type of resource defined in [<a href="https://tools.ietf.org/html/rfc7089#section-1.1">Memento</a>] that
179179
contains a machine-readable listing of <a>URI-M</a>s associated to a given <a>URI-R</a>.
180180
</dd>
181181
</dl>
@@ -188,15 +188,15 @@ <h2>General</h2>
188188
<p>
189189
If a <code>Link: rel="type"</code> header specifies an <a>LDP-NR</a> interaction model
190190
(<code>ldp:NonRDFSource</code>), then the server SHOULD handle subsequent requests
191-
to the newly created resource as if it is a <a>LDP-NR</a>.
191+
to the newly created resource as if it is a <a>LDP-NR</a>.
192192
([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpc-post-createrdf">5.2.3.4 extension</a>)
193193
</p>
194194
<section id="LDPC">
195195
<h2>LDP Containers</h2>
196196
<p>
197197
Implementations MUST support the creation and management of [[!LDP]] Containers.
198198
LDP Direct Containers MUST NOT permit <code>ldp:contains</code> as their membership-predicate
199-
and requests that would do so MUST fail with 409 Conflict.
199+
and requests that would do so MUST fail with 409 Conflict.
200200
([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpdc-containtriples">5.4.1.4 expansion</a>)
201201
</p>
202202
</section>
@@ -205,25 +205,25 @@ <h2>LDP Containers</h2>
205205
<section id="httpPATCH">
206206
<h2>HTTP PATCH</h2>
207207
<p>
208-
Any <a>LDP-RS</a> MUST support PATCH ([[!LDP]]
209-
<a href="https://www.w3.org/TR/ldp/#ldpr-HTTP_PATCH">4.2.7</a> MAY becomes MUST).
210-
[[!sparql11-update]] MUST be an accepted content-type for PATCH. Other content-types (e.g. [[ldpatch]])
211-
MAY be available. If an otherwise valid HTTP PATCH request is received that attempts to add statements to a
212-
resource that a server disallows (not ignores per [[!LDP]]
208+
Any <a>LDP-RS</a> MUST support <code>PATCH</code> ([[!LDP]]
209+
<a href="https://www.w3.org/TR/ldp/#ldpr-HTTP_PATCH">4.2.7</a> MAY becomes MUST).
210+
[[!sparql11-update]] MUST be an accepted content-type for <code>PATCH</code>. Other content-types (e.g. [[ldpatch]])
211+
MAY be available. If an otherwise valid HTTP <code>PATCH</code> request is received that attempts to add statements to a
212+
resource that a server disallows (not ignores per [[!LDP]]
213213
<a href="https://www.w3.org/TR/ldp/#ldpr-put-replaceall">4.2.4.1</a>), the server MUST fail
214214
the request by responding with a 4xx range status code (e.g. 409 Conflict). The server MUST
215215
provide a corresponding response body containing information about which statements could
216-
not be persisted. ([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldprs-put-failed">4.2.4.4</a> SHOULD becomes
217-
MUST). In that response the restrictions causing such a request to fail MUST be described in a resource
218-
indicated by a <code>Link: rel="http://www.w3.org/ns/ldp#constrainedBy"</code> response header per
216+
not be persisted. ([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldprs-put-failed">4.2.4.4</a> SHOULD becomes
217+
MUST). In that response the restrictions causing such a request to fail MUST be described in a resource
218+
indicated by a <code>Link: rel="http://www.w3.org/ns/ldp#constrainedBy"</code> response header per
219219
[[!LDP]] <a href='https://www.w3.org/TR/ldp/#ldpr-gen-pubclireqs'>4.2.1.6</a>.
220-
A successful PATCH request MUST respond with a 2xx status code; the specific code in the 2xx
220+
A successful <code>PATCH</code> request MUST respond with a 2xx status code; the specific code in the 2xx
221221
range MAY vary according to the response body or request state.
222222
</p>
223223
<section id="httpPATCH-ixn-models">
224224
<h3>Interaction models</h3>
225225
<p>
226-
The server MUST disallow a PATCH request that would change the LDP interaction model of a
226+
The server MUST disallow a <code>PATCH</code> request that would change the LDP interaction model of a
227227
resource to a type that is not a subtype of the current resource type. That request MUST be
228228
rejected with a 409 Conflict response.
229229
</p>
@@ -233,25 +233,25 @@ <h3>Interaction models</h3>
233233
<section id="httpPOST">
234234
<h2>HTTP POST</h2>
235235
<p>
236-
Any <a>LDPC</a> MUST support POST ([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpr-HTTP_POST">4.2.3</a> /
236+
Any <a>LDPC</a> MUST support <code>POST</code> ([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpr-HTTP_POST">4.2.3</a> /
237237
<a href="https://www.w3.org/TR/ldp/#ldpc-HTTP_POST">5.2.3</a>). The default interaction model that
238238
will be assigned when there is no explicit Link header in the request MUST be recorded
239239
in the constraints document referenced in the <code>Link: rel="http://www.w3.org/ns/ldp#constrainedBy"</code>
240-
header ([[!LDP]] <a href='https://www.w3.org/TR/ldp/#ldpr-gen-pubclireqs'>4.2.1.6</a> clarification).
241-
Any <a>LDPC</a> MUST support creation of <a>LDP-NR</a>s on POST ([[!LDP]]
242-
<a href="https://www.w3.org/TR/ldp/#h-ldpc-post-createbins">5.2.3.3</a> MAY becomes MUST). On creation of an
243-
<a>LDP-NR</a> an implementation MUST create an associated <a>LDP-RS</a> describing that <a>LDP-NR</a>
240+
header ([[!LDP]] <a href='https://www.w3.org/TR/ldp/#ldpr-gen-pubclireqs'>4.2.1.6</a> clarification).
241+
Any <a>LDPC</a> MUST support creation of <a>LDP-NR</a>s on <code>POST</code> ([[!LDP]]
242+
<a href="https://www.w3.org/TR/ldp/#h-ldpc-post-createbins">5.2.3.3</a> MAY becomes MUST). On creation of an
243+
<a>LDP-NR</a> an implementation MUST create an associated <a>LDP-RS</a> describing that <a>LDP-NR</a>
244244
([[!LDP]] <a href="https://www.w3.org/TR/ldp/#h-ldpc-post-createbinlinkmetahdr">5.2.3.12</a> MAY becomes MUST).
245245
</p>
246246
<section id="httpPOSTLDPNR">
247247
<h2>LDP-NRs</h2>
248248
<p>
249-
A HTTP POST request that would create a <a>LDP-NR</a> and includes a <code>Digest</code> header
249+
A HTTP <code>POST</code> request that would create a <a>LDP-NR</a> and includes a <code>Digest</code> header
250250
(as described in [[!RFC3230]]) for which the instance-digest in that header does not
251251
match that of the new <a>LDP-NR</a> MUST be rejected with a 409 Conflict response.
252252
</p>
253253
<p>
254-
A HTTP POST request that includes an unsupported <code>Digest</code> type (as described
254+
A HTTP <code>POST</code> request that includes an unsupported <code>Digest</code> type (as described
255255
in [[!RFC3230]]), SHOULD be rejected with a 400 Bad Request response.
256256
</p>
257257
<p>
@@ -267,7 +267,7 @@ <h2>LDP-NRs</h2>
267267
<section id="httpPUT">
268268
<h2>HTTP PUT</h2>
269269
<p>
270-
When accepting a PUT request against an extant resource, an HTTP <code>Link: rel="type"</code>
270+
When accepting a <code>PUT</code> request against an extant resource, an HTTP <code>Link: rel="type"</code>
271271
header MAY be included. If that type is a value in the LDP namespace and is not either a
272272
current type of the resource or a subtype of a current type of the resource, the request MUST be
273273
rejected with a 409 Conflict response. If the type in the Link header is a subtype of a current type
@@ -278,15 +278,15 @@ <h2>HTTP PUT</h2>
278278
<section id="httpPUTLDPNR">
279279
<h2><a>LDP-NR</a>s</h2>
280280
<p>
281-
Any <a>LDP-NR</a> MUST support PUT to replace the binary content of that resource.
281+
Any <a>LDP-NR</a> MUST support <code>PUT</code> to replace the binary content of that resource.
282282
</p>
283283
<p>
284-
A HTTP PUT request that includes a <code>Digest</code> header (as described
284+
A HTTP <code>PUT</code> request that includes a <code>Digest</code> header (as described
285285
in [[!RFC3230]]) for which any instance-digest in that header does not match the instance
286286
it describes, MUST be rejected with a 409 Conflict response.
287287
</p>
288288
<p>
289-
A HTTP PUT request that includes an unsupported <code>Digest</code> type (as described
289+
A HTTP <code>PUT</code> request that includes an unsupported <code>Digest</code> type (as described
290290
in [[!RFC3230]]), SHOULD be rejected with a 400 Bad Request response.
291291
</p>
292292
<p>
@@ -301,26 +301,26 @@ <h2><a>LDP-NR</a>s</h2>
301301
<section id="httpPUTLDPRS">
302302
<h2>LDP-RSs</h2>
303303
<p>
304-
Any <a>LDP-RS</a> MUST support PUT to update statements that are not server-managed triples
305-
(as defined in [[!LDP]] 2). [[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpr-put-replaceall">4.2.4.1</a>
306-
and <a href="https://www.w3.org/TR/ldp/#ldprs-put-servermanagedprops">4.2.4.3</a> remain in effect. If an
307-
otherwise valid HTTP PUT request is received that attempts to add statements to a resource that a
308-
server disallows (not ignores per [[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpr-put-replaceall">4.2.4.1</a>),
309-
the server MUST fail the request by responding with a 4xx range status code (e.g. 409 Conflict). The server
304+
Any <a>LDP-RS</a> MUST support <code>PUT</code> to update statements that are not server-managed triples
305+
(as defined in [[!LDP]] 2). [[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpr-put-replaceall">4.2.4.1</a>
306+
and <a href="https://www.w3.org/TR/ldp/#ldprs-put-servermanagedprops">4.2.4.3</a> remain in effect. If an
307+
otherwise valid HTTP <code>PUT</code> request is received that attempts to add statements to a resource that a
308+
server disallows (not ignores per [[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldpr-put-replaceall">4.2.4.1</a>),
309+
the server MUST fail the request by responding with a 4xx range status code (e.g. 409 Conflict). The server
310310
MUST provide a corresponding response body containing information about which statements could not be
311-
persisted. ([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldprs-put-failed">4.2.4.4</a> SHOULD becomes MUST).
312-
In that response the restrictions causing such a request to fail MUST be described in a resource indicated
313-
by a <code>Link: rel="http://www.w3.org/ns/ldp#constrainedBy"</code> response header per [[!LDP]]
311+
persisted. ([[!LDP]] <a href="https://www.w3.org/TR/ldp/#ldprs-put-failed">4.2.4.4</a> SHOULD becomes MUST).
312+
In that response the restrictions causing such a request to fail MUST be described in a resource indicated
313+
by a <code>Link: rel="http://www.w3.org/ns/ldp#constrainedBy"</code> response header per [[!LDP]]
314314
<a href='https://www.w3.org/TR/ldp/#ldpr-gen-pubclireqs'>4.2.1.6</a>.
315315
</p>
316316
</section>
317317

318318
<section id="httpPUTcreate">
319319
<h2>Creating resources with HTTP PUT</h2>
320320
<p>
321-
An implementation MUST accept HTTP PUT to create resources.([[!LDP]]
321+
An implementation MUST accept HTTP <code>PUT</code> to create resources.([[!LDP]]
322322
<a href="https://www.w3.org/TR/ldp/#ldpr-put-create">4.2.4.6</a> MAY becomes MUST). The default interaction model that will
323-
be assigned when there is no explicit <code>Link: rel="type"</code> header in the request MUST be recorded
323+
be assigned when there is no explicit <code>Link: rel="type"</code> header in the request MUST be recorded
324324
in the constraints document referenced in the <code>Link: rel="http://www.w3.org/ns/ldp#constrainedBy"</code>
325325
header ([[!LDP]] <a href='https://www.w3.org/TR/ldp/#ldpr-gen-pubclireqs'>4.2.1.6</a> clarification).
326326
</p>
@@ -357,18 +357,18 @@ <h2>Additional values for the <code>Prefer</code> header</h2>
357357
<section id="httpGETLDPNR">
358358
<h2><a>LDP-NR</a>s</h2>
359359
<p>
360-
GET requests to any <a>LDP-NR</a> MUST correctly respond to the <code>Want-Digest</code> header
360+
<code>GET</code> requests to any <a>LDP-NR</a> MUST correctly respond to the <code>Want-Digest</code> header
361361
defined in [[!RFC3230]] unless the <code>Content-Type</code> of the <a>LDP-NR</a> is a
362362
<code>message/external-body</code> extension.
363363
</p>
364364
<p>
365-
GET requests to a <a>LDP-NR</a> with <code>Content-Type: message/external-body</code>, MUST result
365+
<code>GET</code> requests to a <a>LDP-NR</a> with <code>Content-Type: message/external-body</code>, MUST result
366366
in an HTTP 3xx redirect message redirecting to the external URL.
367367
</p>
368368
<section id="httpGETLDPNR-fixity-expectation">
369369
<h3><code>Expect: 202-digest</code></h3>
370370
<p>
371-
GET requests to a <a>LDP-NR</a> SHOULD respond to <code>Expect</code> request headers with a
371+
<code>GET</code> requests to a <a>LDP-NR</a> SHOULD respond to <code>Expect</code> request headers with a
372372
parameterized <a href="#202-digest"><code>202-digest</code></a> expectation. Implementations
373373
MAY support unparameterized <code>202-digest</code> expectations. Implementations that do not
374374
support one of these expectations MUST reject <a href="#202-digest">202-digest</a> requests
@@ -431,7 +431,7 @@ <h2>HTTP PUT</h2>
431431
<section id="httpput-general">
432432
<h2>General</h2>
433433
<p>
434-
An <a>LDPRv</a> MAY support PUT. An implementation receiving a PUT request for an
434+
An <a>LDPRv</a> MAY support <code>PUT</code>. An implementation receiving a <code>PUT</code> request for an
435435
<a>LDPRv</a> MUST both correctly respond as per [[!LDP]] as well as create a new
436436
<a>LDPRm</a> contained in an appropriate <a>LDPCv</a>. The newly-created <a>LDPRm</a>
437437
SHOULD be the version of the <a>LDPRv</a> that was created by the <code>PUT</code> request.
@@ -479,7 +479,7 @@ <h2>General</h2>
479479
<section>
480480
<h2>HTTP DELETE</h2>
481481
<p>
482-
An implementation MAY support <code>DELETE</code> for <a>LDPRm</a>s. If DELETE is
482+
An implementation MAY support <code>DELETE</code> for <a>LDPRm</a>s. If <code>DELETE</code> is
483483
supported, the server is responsible for all behaviors implied by the LDP-containment
484484
of the <a>LDPRm</a>.
485485
</p>
@@ -577,7 +577,7 @@ <h2>HTTP OPTIONS</h2>
577577
An implementation MUST <code>Allow: GET, HEAD, OPTIONS</code> as per [[!LDP]]. An
578578
implementation MAY <code>Allow: DELETE</code> if the versioning behavior is removable
579579
by deleting the <a>LDPCv</a>. See <a href='#ldpcvdelete'></a> for requirements on
580-
DELETE if supported.
580+
<code>DELETE</code> if supported.
581581
</p>
582582
<p>
583583
An implementation MAY <code>Allow: PATCH</code> if the <a>LDPCv</a> has mutable properties.
@@ -709,7 +709,7 @@ <h2>What is fixity?</h2>
709709
<h2>Transmission Fixity</h2>
710710
<p>
711711
Transmission fixity is verified by application of the <code>Digest</code> header
712-
defined in [[RFC3230]] to POST and PUT requests for <a>LDP-NR</a>.
712+
defined in [[RFC3230]] to <code>POST</code> and <code>PUT</code> requests for <a>LDP-NR</a>.
713713
</p>
714714
</section>
715715

0 commit comments

Comments
 (0)