Changeset 2058 for draft-ietf-httpbis

Timestamp:

27/12/12 16:55:15 (10 years ago)

Author:

fielding@…

Message:

editorial improvements to 5xx status codes; partly addresses #419

Location:

draft-ietf-httpbis/latest

Files:

• p2-semantics.html (modified) (2 diffs)
• p2-semantics.xml (modified) (8 diffs)

draft-ietf-httpbis/latest/p2-semantics.html

@@ -2608 +2608 @@
       <div id="rfc.iref.74"></div>
       <h3 id="rfc.section.6.5.3"><a href="#rfc.section.6.5.3">6.5.3</a>&nbsp;<a id="status.403" href="#status.403">403 Forbidden</a></h3>
-      <p id="rfc.section.6.5.3.p.1">The <dfn>403 (Forbidden)</dfn> status code indicates that the origin server understood the request but refuses to authorize it. A server that wishes to make
-         public why the request has been forbidden can describe that reason in the response payload (if any).
-      </p>
-      <p id="rfc.section.6.5.3.p.2">If authentication credentials were provided in the request, the origin server considers them insufficient to grant access.
-         The client <em class="bcp14">SHOULD NOT</em> repeat the request with the same credentials. The client <em class="bcp14">MAY</em> repeat the request with new or different credentials. However, a request might be forbidden for reasons unrelated to the credentials.
+      <p id="rfc.section.6.5.3.p.1">The <dfn>403 (Forbidden)</dfn> status code indicates that the server understood the request but refuses to authorize it. A server that wishes to make public
+         why the request has been forbidden can describe that reason in the response payload (if any).
+      </p>
+      <p id="rfc.section.6.5.3.p.2">If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client <em class="bcp14">SHOULD NOT</em> repeat the request with the same credentials. The client <em class="bcp14">MAY</em> repeat the request with new or different credentials. However, a request might be forbidden for reasons unrelated to the credentials.
       </p>
       <p id="rfc.section.6.5.3.p.3">An origin server that wishes to "hide" the current existence of a forbidden <a href="#resources" class="smpl">target resource</a>  <em class="bcp14">MAY</em> instead respond with a status code of <a href="#status.404" class="smpl">404 (Not Found)</a>.
@@ -2717 +2716 @@
       <div id="rfc.iref.75"></div>
       <h3 id="rfc.section.6.6.1"><a href="#rfc.section.6.6.1">6.6.1</a>&nbsp;<a id="status.500" href="#status.500">500 Internal Server Error</a></h3>
-      <p id="rfc.section.6.6.1.p.1">The server encountered an unexpected condition which prevented it from fulfilling the request.</p>
+      <p id="rfc.section.6.6.1.p.1">The <dfn>500 (Internal Server Error)</dfn> status code indicates that the server encountered an unexpected condition which prevented it from fulfilling the request.
+      </p>
       <div id="rfc.iref.75"></div>
       <h3 id="rfc.section.6.6.2"><a href="#rfc.section.6.6.2">6.6.2</a>&nbsp;<a id="status.501" href="#status.501">501 Not Implemented</a></h3>
-      <p id="rfc.section.6.6.2.p.1">The server does not support the functionality required to fulfill the request. This is the appropriate response when the server
-         does not recognize the request method and is not capable of supporting it for any resource.
+      <p id="rfc.section.6.6.2.p.1">The <dfn>501 (Not Implemented)</dfn> status code indicates that the server does not support the functionality required to fulfill the request. This is the appropriate
+         response when the server does not recognize the request method and is not capable of supporting it for any resource.
       </p>
       <div id="rfc.iref.75"></div>
       <h3 id="rfc.section.6.6.3"><a href="#rfc.section.6.6.3">6.6.3</a>&nbsp;<a id="status.502" href="#status.502">502 Bad Gateway</a></h3>
-      <p id="rfc.section.6.6.3.p.1">The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting
-         to fulfill the request.
+      <p id="rfc.section.6.6.3.p.1">The <dfn>502 (Bad Gateway)</dfn> status code indicates that the server, while acting as a gateway or proxy, received an invalid response from an inbound server
+         it accessed while attempting to fulfill the request.
       </p>
       <div id="rfc.iref.75"></div>
       <h3 id="rfc.section.6.6.4"><a href="#rfc.section.6.6.4">6.6.4</a>&nbsp;<a id="status.503" href="#status.503">503 Service Unavailable</a></h3>
-      <p id="rfc.section.6.6.4.p.1">The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.</p>
-      <p id="rfc.section.6.6.4.p.2">The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the
-         delay <em class="bcp14">MAY</em> be indicated in a <a href="#header.retry-after" class="smpl">Retry-After</a> header field (<a href="#header.retry-after" id="rfc.xref.header.retry-after.1" title="Retry-After">Section&nbsp;7.1.3</a>). If no Retry-After is given, the client <em class="bcp14">SHOULD</em> handle the response as it would for a <a href="#status.500" class="smpl">500 (Internal
-            Server Error)</a> response.
-      </p>
-      <div class="note" id="rfc.section.6.6.4.p.3"> 
+      <p id="rfc.section.6.6.4.p.1">The <dfn>503 (Service Unavailable)</dfn> status code indicates that the server is currently unable to handle the request due to a temporary overload or scheduled maintenance,
+         which will likely be alleviated after some delay. The server <em class="bcp14">MAY</em> send a <a href="#header.retry-after" class="smpl">Retry-After</a> header field (<a href="#header.retry-after" id="rfc.xref.header.retry-after.1" title="Retry-After">Section&nbsp;7.1.3</a>) to suggest an appropriate amount of time for the client to wait before retrying the request.
+      </p>
+      <div class="note" id="rfc.section.6.6.4.p.2"> 
          <p> <b>Note:</b> The existence of the 503 status code does not imply that a server has to use it when becoming overloaded. Some servers might
-            wish to simply refuse the connection.
+            simply refuse the connection.
          </p> 
       </div>
       <div id="rfc.iref.75"></div>
       <h3 id="rfc.section.6.6.5"><a href="#rfc.section.6.6.5">6.6.5</a>&nbsp;<a id="status.504" href="#status.504">504 Gateway Timeout</a></h3>
-      <p id="rfc.section.6.6.5.p.1">The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the
-         URI (e.g., HTTP, FTP, LDAP) or some other auxiliary server (e.g., DNS) it needed to access in attempting to complete the request.
-      </p>
-      <div class="note" id="rfc.section.6.6.5.p.2"> 
-         <p> <b>Note</b> to implementers: some deployed proxies are known to send <a href="#status.400" class="smpl">400 (Bad Request)</a> or <a href="#status.500" class="smpl">500 (Internal Server
-               Error)</a> when DNS lookups time out.
-         </p> 
-      </div>
+      <p id="rfc.section.6.6.5.p.1">The <dfn>504 (Gateway Timeout)</dfn> status code indicates that the server, while acting as a gateway or proxy, did not receive a timely response from an upstream
+         server it needed to access in order to complete the request.
+      </p>
       <div id="rfc.iref.75"></div>
       <h3 id="rfc.section.6.6.6"><a href="#rfc.section.6.6.6">6.6.6</a>&nbsp;<a id="status.505" href="#status.505">505 HTTP Version Not Supported</a></h3>
-      <p id="rfc.section.6.6.6.p.1">The server does not support, or refuses to support, the protocol version that was used in the request message. The server
-         is indicating that it is unable or unwilling to complete the request using the same major version as the client, as described
-         in <a href="p1-messaging.html#http.version" title="Protocol Versioning">Section 2.6</a> of <a href="#Part1" id="rfc.xref.Part1.28"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a>, other than with this error message. The response <em class="bcp14">SHOULD</em> contain a representation describing why that version is not supported and what other protocols are supported by that server.
+      <p id="rfc.section.6.6.6.p.1">The <dfn>505 (HTTP Version Not Supported)</dfn> status code indicates that the server does not support, or refuses to support, the protocol version that was used in the request
+         message. The server is indicating that it is unable or unwilling to complete the request using the same major version as the
+         client, as described in <a href="p1-messaging.html#http.version" title="Protocol Versioning">Section 2.6</a> of <a href="#Part1" id="rfc.xref.Part1.28"><cite title="Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing">[Part1]</cite></a>, other than with this error message. The server <em class="bcp14">SHOULD</em> generate a representation for the 505 response that describes why that version is not supported and what other protocols are
+         supported by that server.
       </p>
       <h1 id="rfc.section.7"><a href="#rfc.section.7">7.</a>&nbsp;<a id="response.header.fields" href="#response.header.fields">Response Header Fields</a></h1>

draft-ietf-httpbis/latest/p2-semantics.xml

@@ -3128 +3128 @@
   <x:anchor-alias value="403 (Forbidden)"/>
 <t>
-   The <x:dfn>403 (Forbidden)</x:dfn> status code indicates that the origin
+   The <x:dfn>403 (Forbidden)</x:dfn> status code indicates that the
    server understood the request but refuses to authorize it.
    A server that wishes to make public why the request has been forbidden
@@ -3134 +3134 @@
 </t>
 <t>
-   If authentication credentials were provided in the request, the origin
+   If authentication credentials were provided in the request, the
    server considers them insufficient to grant access.
    The client &SHOULD-NOT; repeat the request with the same credentials.
@@ -3378 +3378 @@
   <x:anchor-alias value="500 (Internal Server Error)"/>
 <t>
-   The server encountered an unexpected condition which prevented it
-   from fulfilling the request.
+   The <x:dfn>500 (Internal Server Error)</x:dfn> status code indicates that
+   the server encountered an unexpected condition which prevented it from
+   fulfilling the request.
 </t>
 </section>
@@ -3387 +3388 @@
   <x:anchor-alias value="501 (Not Implemented)"/>
 <t>
-   The server does not support the functionality required to fulfill the
-   request. This is the appropriate response when the server does not
-   recognize the request method and is not capable of supporting it for
-   any resource.
+   The <x:dfn>501 (Not Implemented)</x:dfn> status code indicates that the
+   server does not support the functionality required to fulfill the request.
+   This is the appropriate response when the server does not recognize the
+   request method and is not capable of supporting it for any resource.
 </t>
 </section>
@@ -3398 +3399 @@
   <x:anchor-alias value="502 (Bad Gateway)"/>
 <t>
-   The server, while acting as a gateway or proxy, received an invalid
-   response from the upstream server it accessed in attempting to
-   fulfill the request.
+   The <x:dfn>502 (Bad Gateway)</x:dfn> status code indicates that the server,
+   while acting as a gateway or proxy, received an invalid response from an
+   inbound server it accessed while attempting to fulfill the request.
 </t>
 </section>
@@ -3408 +3409 @@
   <x:anchor-alias value="503 (Service Unavailable)"/>
 <t>
-   The server is currently unable to handle the request due to a
-   temporary overloading or maintenance of the server.
-</t>
-<t>
-   The implication is that this is a temporary condition which will be
-   alleviated after some delay. If known, the length of the delay &MAY; be
-   indicated in a <x:ref>Retry-After</x:ref> header field
-   (<xref target="header.retry-after"/>). If no Retry-After is given, the
-   client &SHOULD; handle the response as it would for a <x:ref>500 (Internal
-   Server Error)</x:ref> response.
+   The <x:dfn>503 (Service Unavailable)</x:dfn> status code indicates that the
+   server is currently unable to handle the request due to a temporary overload
+   or scheduled maintenance, which will likely be alleviated after some delay.
+   The server &MAY; send a <x:ref>Retry-After</x:ref> header field
+   (<xref target="header.retry-after"/>) to suggest an appropriate
+   amount of time for the client to wait before retrying the request.
 </t>
 <x:note>
   <t>
     &Note; The existence of the 503 status code does not imply that a
-    server has to use it when becoming overloaded. Some servers might wish
-    to simply refuse the connection.
+    server has to use it when becoming overloaded. Some servers might
+    simply refuse the connection.
   </t>
 </x:note>
@@ -3432 +3429 @@
   <x:anchor-alias value="504 (Gateway Timeout)"/>
 <t>
-   The server, while acting as a gateway or proxy, did not receive a
-   timely response from the upstream server specified by the URI (e.g.,
-   HTTP, FTP, LDAP) or some other auxiliary server (e.g., DNS) it needed
-   to access in attempting to complete the request.
-</t>
-<x:note>
-  <t>
-    <x:h>Note</x:h> to implementers: some deployed proxies are known to
-    send <x:ref>400 (Bad Request)</x:ref> or <x:ref>500 (Internal Server
-    Error)</x:ref> when DNS lookups time out.
-  </t>
-</x:note>
+   The <x:dfn>504 (Gateway Timeout)</x:dfn> status code indicates that the
+   server, while acting as a gateway or proxy, did not receive a timely
+   response from an upstream server it needed to access in order to
+   complete the request.
+</t>
 </section>
 
@@ -3450 +3440 @@
   <x:anchor-alias value="505 (HTTP Version Not Supported)"/>
 <t>
-   The server does not support, or refuses to support, the protocol
-   version that was used in the request message. The server is
-   indicating that it is unable or unwilling to complete the request
-   using the same major version as the client, as described in &http-version;,
-   other than with this error message. The response &SHOULD; contain
-   a representation describing why that version is not supported and what other
+   The <x:dfn>505 (HTTP Version Not Supported)</x:dfn> status code indicates
+   that the server does not support, or refuses to support, the protocol
+   version that was used in the request message. The server is indicating that
+   it is unable or unwilling to complete the request using the same major
+   version as the client, as described in &http-version;, other than with this
+   error message. The server &SHOULD; generate a representation for the 505
+   response that describes why that version is not supported and what other
    protocols are supported by that server.
 </t>