Mirrors/httpstatuses
1
0
Fork 0
mirror of https://github.com/rmaake1/httpstatuses.git synced 2024-10-04 15:17:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Improves 3xx class status codes with references

Browse Source
This commit is contained in:
Samuel Ryan 2015-11-09 01:06:31 +00:00
parent 196d9c67ce
commit af7257eea0
8 changed files with 87 additions and 66 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
contents/codes/300.md
View File

@ -6,13 +6,14 @@ references:
"Rails HTTP Status Symbol": ":multiple_choices" "Rails HTTP Status Symbol": ":multiple_choices"
--- ---
The 300 Multiple Choices status code indicates that the target resource has The target resource has more than one representation, each with its own more
more than one representation, each with its own more specific identifier, and specific identifier, and information about the alternatives is being provided
information about the alternatives is being provided so that the user (or user so that the user (or user agent) can select a preferred representation by
agent) can select a preferred representation by redirecting its request to one redirecting its request to one or more of those identifiers.
or more of those identifiers. In other words, the server desires that the user
agent engage in reactive negotiation to select the most appropriate In other words, the server desires that the user agent engage in reactive
representation(s) for its needs ([RFC7231 Section 3.4][2]). negotiation to select the most appropriate representation(s) for its
needs<sup>[1](#ref-1)</sup>.
If the server has a preferred choice, the server SHOULD generate a Location If the server has a preferred choice, the server SHOULD generate a Location
header field containing a preferred choice's URI reference. The user agent MAY header field containing a preferred choice's URI reference. The user agent MAY
@ -29,19 +30,25 @@ format believed to be acceptable to the user agent, as determined by shared
design or content negotiation, or in some commonly accepted hypertext format. design or content negotiation, or in some commonly accepted hypertext format.
A 300 response is cacheable by default; i.e., unless otherwise indicated by the A 300 response is cacheable by default; i.e., unless otherwise indicated by the
method definition or explicit cache controls (see method definition or explicit cache controls<sup>[2](#ref-2)</sup>.
[Section 4.2.2 of RFC7234][3]).
Note: The original proposal for the 300 status code defined the URI header field Note: The original proposal for the 300 status code defined the URI header field
as providing a list of alternative representations, such that it would be usable as providing a list of alternative representations, such that it would be usable
for 200, 300, and 406 responses and be transferred in responses to the HEAD for 200, 300, and 406 responses and be transferred in responses to the HEAD
method. However, lack of deployment and disagreement over syntax led to both URI method. However, lack of deployment and disagreement over syntax led to both URI
and Alternates (a subsequent proposal) being dropped from this specification. It and Alternates (a subsequent proposal) being dropped from this specification. It
is possible to communicate the list using a set of Link header fields is possible to communicate the list using a set of Link header
[[RFC5988][4]], each with a relationship of "alternate", though deployment is a fields<sup>[3](#ref-3)</sup>, each with a relationship of "alternate",
chicken-and-egg problem. though deployment is a chicken-and-egg problem.
Source: [RFC7231 Section 6.4.1][1] ---
* <span id="ref-1"><sup>1</sup> Content Negotiation
[RFC7231 Section 3.4][2]</span>
* <span id="ref-2"><sup>2</sup> Calculating Heuristic Freshness
[Section 4.2.2 of RFC7234][3]</span>
* <span id="ref-3"><sup>3</sup> Web Linking [RFC5988][4]</span>
* Source: [RFC7231 Section 6.4.1][1]
[1]: <http://tools.ietf.org/html/rfc7231#section-6.4.1> [1]: <http://tools.ietf.org/html/rfc7231#section-6.4.1>
[2]: <http://tools.ietf.org/html/rfc7231#section-3.4> [2]: <http://tools.ietf.org/html/rfc7231#section-3.4>

16
contents/codes/301.md
View File

@ -6,9 +6,8 @@ references:
"Rails HTTP Status Symbol": ":moved_permanently" "Rails HTTP Status Symbol": ":moved_permanently"
--- ---
The 301 Moved Permanently status code indicates that the target resource has The target resource has been assigned a new permanent URI and any future
been assigned a new permanent URI and any future references to this resource references to this resource ought to use one of the enclosed URIs.
ought to use one of the enclosed URIs.
Clients with link-editing capabilities ought to automatically re-link references Clients with link-editing capabilities ought to automatically re-link references
to the effective request URI to one or more of the new references sent by the to the effective request URI to one or more of the new references sent by the
@ -21,13 +20,16 @@ usually contains a short hypertext note with a hyperlink to the new URI(s).
Note: For historical reasons, a user agent MAY change the request method from Note: For historical reasons, a user agent MAY change the request method from
POST to GET for the subsequent request. If this behavior is undesired, the POST to GET for the subsequent request. If this behavior is undesired, the
[307 (Temporary Redirect)](/307) status code can be used instead. [307 Temporary Redirect](/307) status code can be used instead.
A 301 response is cacheable by default; i.e., unless otherwise indicated by the A 301 response is cacheable by default; i.e., unless otherwise indicated by the
method definition or explicit cache controls method definition or explicit cache controls<sup>[1](#ref-1)</sup>.
(see [Section 4.2.2 of [RFC7234]][2]).
Source: [RFC7231 Section 6.4.2][1] ---
* <span id="ref-1"><sup>1</sup> Calculating Heuristic Freshness
[RFC7234 Section 4.2.2][2]</span>
* Source: [RFC7231 Section 6.4.2][1]
[1]: <http://tools.ietf.org/html/rfc7231#section-6.4.2> [1]: <http://tools.ietf.org/html/rfc7231#section-6.4.2>
[2]: <http://tools.ietf.org/html/rfc7234#section-4.2.2> [2]: <http://tools.ietf.org/html/rfc7234#section-4.2.2>

13
contents/codes/302.md
View File

@ -6,10 +6,9 @@ references:
"Rails HTTP Status Symbol": ":found" "Rails HTTP Status Symbol": ":found"
--- ---
The 302 Found status code indicates that the target resource resides temporarily The target resource resides temporarily under a different URI. Since the
under a different URI. Since the redirection might be altered on redirection might be altered on occasion, the client ought to continue to use
occasion, the client ought to continue to use the effective request URI for the effective request URI for future requests.
future requests.
The server SHOULD generate a Location header field in the response containing a The server SHOULD generate a Location header field in the response containing a
URI reference for the different URI. The user agent MAY use the Location field URI reference for the different URI. The user agent MAY use the Location field
@ -18,8 +17,10 @@ a short hypertext note with a hyperlink to the different URI(s).
Note: For historical reasons, a user agent MAY change the request method from Note: For historical reasons, a user agent MAY change the request method from
POST to GET for the subsequent request. If this behavior is undesired, the POST to GET for the subsequent request. If this behavior is undesired, the
[307 (Temporary Redirect)](/307) status code can be used instead. [307 Temporary Redirect](/307) status code can be used instead.
Source: [RFC7231 Section 6.4.3][1] ---
* Source: [RFC7231 Section 6.4.3][1]
[1]: <http://tools.ietf.org/html/rfc7231#section-6.4.3> [1]: <http://tools.ietf.org/html/rfc7231#section-6.4.3>

11
contents/codes/303.md
View File

@ -6,10 +6,9 @@ references:
"Rails HTTP Status Symbol": ":see_other" "Rails HTTP Status Symbol": ":see_other"
--- ---
The 303 See Other status code indicates that the server is redirecting the The server is redirecting the user agent to a different resource, as indicated
user agent to a different resource, as indicated by a URI in the Location header by a URI in the Location header field, which is intended to provide an indirect
field, which is intended to provide an indirect response to the original response to the original request.
request.
A user agent can perform a retrieval request targeting that URI (a GET A user agent can perform a retrieval request targeting that URI (a GET
or HEAD request if using HTTP), which might also be redirected, and present the or HEAD request if using HTTP), which might also be redirected, and present the
@ -36,6 +35,8 @@ Except for responses to a HEAD request, the representation of a 303 response
ought to contain a short hypertext note with a hyperlink to the same URI ought to contain a short hypertext note with a hyperlink to the same URI
reference provided in the Location header field. reference provided in the Location header field.
Source: [RFC7321 Section 6.4.4][1] ---
* Source: [RFC7321 Section 6.4.4][1]
[1]: <http://tools.ietf.org/html/rfc7231#section-6.4.4> [1]: <http://tools.ietf.org/html/rfc7231#section-6.4.4>

14
contents/codes/304.md
View File

@ -6,18 +6,18 @@ references:
"Rails HTTP Status Symbol": ":not_modified" "Rails HTTP Status Symbol": ":not_modified"
--- ---
The 304 Not Modified status code indicates that a conditional GET or HEAD A conditional GET or HEAD request has been received and would have resulted in a
request has been received and would have resulted in a [200 (OK)](/200) response [200 OK](/200) response if it were not for the fact that the condition evaluated
if it were not for the fact that the condition evaluated to false. to false.
In other words, there is no need for the server to transfer a representation of In other words, there is no need for the server to transfer a representation of
the target resource because the request indicates that the client, which made the target resource because the request indicates that the client, which made
the request conditional, already has a valid representation; the server is the request conditional, already has a valid representation; the server is
therefore redirecting the client to make use of that stored representation as if therefore redirecting the client to make use of that stored representation as if
it were the payload of a [200 (OK)](/200) response. it were the payload of a [200 OK](/200) response.
The server generating a 304 response MUST generate any of the following header The server generating a 304 response MUST generate any of the following header
fields that would have been sent in a [200 (OK)](/200) response to the same fields that would have been sent in a [200 OK](/200) response to the same
request: Cache-Control, Content-Location, Date, ETag, Expires, and Vary. request: Cache-Control, Content-Location, Date, ETag, Expires, and Vary.
Since the goal of a 304 response is to minimize information transfer when the Since the goal of a 304 response is to minimize information transfer when the
@ -35,7 +35,9 @@ client.
A 304 response cannot contain a message-body; it is always terminated by the A 304 response cannot contain a message-body; it is always terminated by the
first empty line after the header fields. first empty line after the header fields.
Source: [RFC7232 Section 4.1][1] ---
* Source: [RFC7232 Section 4.1][1]
[1]: <http://tools.ietf.org/html/rfc7232#section-4.1> [1]: <http://tools.ietf.org/html/rfc7232#section-4.1>
[2]: <http://tools.ietf.org/html/rfc7234#section-4.3.4> [2]: <http://tools.ietf.org/html/rfc7234#section-4.3.4>

9
contents/codes/305.md
View File

@ -7,10 +7,11 @@ title: Use Proxy
# - Due to deprecation we won't show this... but should we? # - Due to deprecation we won't show this... but should we?
--- ---
The 305 Use Proxy status code was defined in a previous version of this Defined in a previous version of this specification and is now deprecated, due
specification and is now deprecated, due to security concerns regarding in-band to security concerns regarding in-band configuration of a proxy.
configuration of a proxy.
Source: [RFC7231 Section 6.4.5][1] ---
* Source: [RFC7231 Section 6.4.5][1]
[1]: <http://tools.ietf.org/html/rfc7231#section-6.4.5> [1]: <http://tools.ietf.org/html/rfc7231#section-6.4.5>

18
contents/codes/307.md
View File

@ -6,24 +6,26 @@ references:
"Rails HTTP Status Symbol": ":temporary_redirect" "Rails HTTP Status Symbol": ":temporary_redirect"
--- ---
The 307 Temporary Redirect status code indicates that the target resource The target resource resides temporarily under a different URI and the user agent
resides temporarily under a different URI and the user agent MUST NOT change the MUST NOT change the request method if it performs an automatic redirection to
request method if it performs an automatic redirection to that URI. that URI.
Since the redirection can change over time, the client ought to continue using Since the redirection can change over time, the client ought to continue using
the original effective request URI for future requests. the original effective request URI for future requests.
The server SHOULD generate a Location header field in the response containing a The server SHOULD generate a Location header field in the response containing a
URI reference for the different URI. The user agent MAY use the Location field URI reference for the different URI. The user agent MAY use the Location field
value for automatic redirection. The server's response payload usually contains value for automatic redirection. The server's response payload usually contains
a short hypertext note with a hyperlink to the different URI(s). a short hypertext note with a hyperlink to the different URI(s).
Note: This status code is similar to 302 (Found), except that it does not allow Note: This status code is similar to 302 Found, except that it does not allow
changing the request method from POST to GET. This specification defines no changing the request method from POST to GET. This specification defines no
equivalent counterpart for [301 (Moved Permanently)](/301) ([RFC7238][2], however, equivalent counterpart for [301 Moved Permanently](/301) ([RFC7238][2], however,
defines the status code [308 (Permanent Redirect)](/308) for this purpose). proposes defining the status code [308 Permanent Redirect](/308) for this purpose).
Source: [RFC7231 Section 6.4.7][1] ---
* Source: [RFC7231 Section 6.4.7][1]
[1]: <http://tools.ietf.org/html/rfc7231#section-6.4.7> [1]: <http://tools.ietf.org/html/rfc7231#section-6.4.7>
[2]: <http://tools.ietf.org/html/rfc7238> [2]: <http://tools.ietf.org/html/rfc7238>

39
contents/codes/308.md
View File

@ -4,31 +4,36 @@ code: 308
title: Permanent Redirect title: Permanent Redirect
--- ---
The 308 Permanent Redirect status code indicates that the target resource has The target resource has been assigned a new permanent URI and any future
been assigned a new permanent URI and any future references to this resource references to this resource ought to use one of the enclosed URIs.
ought to use one of the enclosed URIs.
Clients with link editing capabilities ought to automatically re-link references Clients with link editing capabilities ought to automatically re-link references
to the effective request URI ([Section 5.5 of RFC7230][2]) to one or more of the to the effective request URI<sup>[1](#ref-1)</sup> to one or more of the new
new references sent by the server, where possible. references sent by the server, where possible.
The server SHOULD generate a Location header field The server SHOULD generate a Location header field<sup>[2](#ref-2)</sup> in the
([[RFC7231], Section 7.1.2][3]) in the response containing a preferred URI response containing a preferred URI reference for the new permanent URI. The
reference for the new permanent URI. The user agent MAY use the Location field user agent MAY use the Location field value for automatic redirection. The
value for automatic redirection. The server's response payload usually contains server's response payload usually contains a short hypertext note with a
a short hypertext note with a hyperlink to the new URI(s). hyperlink to the new URI(s).
A 308 response is cacheable by default; i.e., unless otherwise indicated by the A 308 response is cacheable by default; i.e., unless otherwise indicated by the
method definition or explicit cache controls ([see RFC7234, Section 4.2.2][4]). method definition or explicit cache controls<sup>[3](#ref-3)</sup>.
Note: This status code is similar to 301 (Moved Permanently) Note: This status code is similar to [301 Moved
([RFC7231, Section 6.4.2][5]), except that it does not allow changing the Permanently](/301), except that it does not allow changing the request method
request method from POST to GET. from POST to GET.
Source: [RFC738 Section 3][1] ---
* <span id="ref-1"><sup>1</sup> Effective Request URI
[RFC7230 Section 5.5][2]</span>
* <span id="ref-2"><sup>2</sup> Location [RFC7231 Section 7.1.2][3]</span>
* <span id="ref-3"><sup>3</sup> Calculating Heuristic Freshness
[RFC7234 Section 4.2.2][4]</span>
* Source: [RFC738 Section 3][1]
[1]: <http://tools.ietf.org/html/rfc7538#section-3> [1]: <http://tools.ietf.org/html/rfc7538#section-3>
[2]: <http://tools.ietf.org/html/rfc7230#section-5.5> [2]: <http://tools.ietf.org/html/rfc7230#section-5.5>
[3]: <http://tools.ietf.org/html/rfc7231#section-7.1.2> [3]: <http://tools.ietf.org/html/rfc7231#section-7.1.2>
[4]: <http://tools.ietf.org/html/rfc7234#section-4.2.2> [4]: <http://tools.ietf.org/html/rfc7234#section-4.2.2>
[5]: <http://tools.ietf.org/html/rfc7231#section-6.4.2>