-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(status): Write in-code documentation
- Loading branch information
1 parent
2debe30
commit e734f6d
Showing
2 changed files
with
80 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // Package status provides constants for all standard HTTP status codes. | ||
| // HTTP status codes are returned by a server in response to a client's request to indicate | ||
| // whether the request was successfully processed, or if there were errors. | ||
| // | ||
| // These codes are divided into categories based on their response type: | ||
| // - Informational responses (100–199): Indicates that the request was received and is being processed. | ||
| // - Successful responses (200–299): Indicates that the request was successfully received, understood, and accepted. | ||
| // - Redirection messages (300–399): Indicates that further action needs to be taken by the client to complete the request. | ||
| // - Client error responses (400–499): Indicates that there was an error with the request sent by the client. | ||
| // - Server error responses (500–599): Indicates that the server encountered an error while processing the request. | ||
| // | ||
| // Each status code is associated with a specific RFC section that defines its usage. | ||
| package status |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,85 +1,75 @@ | ||
| package status | ||
|
|
||
| // This file lists all the HTTP status codes as constants. | ||
| // | ||
| // HTTP status codes are returned by a server in response to a client's | ||
| // request made to the server. They are used to indicate whether | ||
| // a specific HTTP request has been successfully completed, and to provide | ||
| // additional information about the request or the server's response. | ||
| // | ||
| // Each status code is followed by a comment that indicates the corresponding | ||
| // section of the RFC (Request for Comments) document that defines the status code. | ||
|
|
||
| const ( | ||
| // Informational responses (100–199): These are informational responses indicating that the request was received and understood. It is issued on a provisional, intermediate basis while the request continues to be processed. | ||
| Continue = 100 // RFC 7231, 6.2.1 | ||
| SwitchingProtocols = 101 // RFC 7231, 6.2.2 | ||
| Processing = 102 // RFC 2518, 10.1 | ||
| EarlyHints = 103 // RFC 8297 | ||
| // Informational responses (100–199): These indicate that the request was received and is being processed, but no final response is available yet. | ||
| Continue = 100 // RFC 7231, 6.2.1 - Request received, continue sending the request. | ||
| SwitchingProtocols = 101 // RFC 7231, 6.2.2 - Server is switching protocols based on the client request. | ||
| Processing = 102 // RFC 2518, 10.1 - Server has received and is processing the request, but no response is available yet. | ||
| EarlyHints = 103 // RFC 8297 - Used to send preliminary response headers before the final response. | ||
|
|
||
| // Successful responses (200–299): These indicate that the client's request was successfully received, understood, and accepted. | ||
| OK = 200 // RFC 7231, 6.3.1 | ||
| Created = 201 // RFC 7231, 6.3.2 | ||
| Accepted = 202 // RFC 7231, 6.3.3 | ||
| NonAuthoritativeInfo = 203 // RFC 7231, 6.3.4 | ||
| NoContent = 204 // RFC 7231, 6.3.5 | ||
| ResetContent = 205 // RFC 7231, 6.3.6 | ||
| PartialContent = 206 // RFC 7233, 4.1 | ||
| MultiStatus = 207 // RFC 4918, 11.1 | ||
| AlreadyReported = 208 // RFC 5842, 7.1 | ||
| IMUsed = 226 // RFC 3229, 10.4.1 | ||
| // Successful responses (200–299): These indicate that the request was successfully received, understood, and accepted. | ||
| OK = 200 // RFC 7231, 6.3.1 - The request succeeded, and the server responded with the requested resource. | ||
| Created = 201 // RFC 7231, 6.3.2 - The request was successful, and a new resource was created as a result. | ||
| Accepted = 202 // RFC 7231, 6.3.3 - The request was accepted for processing, but processing is not yet complete. | ||
| NonAuthoritativeInfo = 203 // RFC 7231, 6.3.4 - The server successfully processed the request but is returning information from a third-party source. | ||
| NoContent = 204 // RFC 7231, 6.3.5 - The server successfully processed the request, but no content is returned. | ||
| ResetContent = 205 // RFC 7231, 6.3.6 - The server successfully processed the request, but the client should reset its document view. | ||
| PartialContent = 206 // RFC 7233, 4.1 - The server is delivering only part of the resource due to a range header sent by the client. | ||
| MultiStatus = 207 // RFC 4918, 11.1 - The response provides status for multiple independent operations (used in WebDAV). | ||
| AlreadyReported = 208 // RFC 5842, 7.1 - The members of a DAV binding have already been reported in a previous response. | ||
| IMUsed = 226 // RFC 3229, 10.4.1 - The server has fulfilled a request for a resource using delta encoding. | ||
|
|
||
| // Redirection messages (300–399):These are used to indicate that the client must take some additional action in order to complete their request. | ||
| MultipleChoices = 300 // RFC 7231, 6.4.1 | ||
| MovedPermanently = 301 // RFC 7231, 6.4.2 | ||
| Found = 302 // RFC 7231, 6.4.3 | ||
| SeeOther = 303 // RFC 7231, 6.4.4 | ||
| NotModified = 304 // RFC 7232, 4.1 | ||
| UseProxy = 305 // RFC 7231, 6.4.5 | ||
| _ = 306 // RFC 7231, 6.4.6 (Unused) | ||
| TemporaryRedirect = 307 // RFC 7231, 6.4.7 | ||
| PermanentRedirect = 308 // RFC 7538, 3 | ||
| // Redirection messages (300–399): These indicate that the client must take additional actions to complete the request. | ||
| MultipleChoices = 300 // RFC 7231, 6.4.1 - There are multiple options for the resource that the client may choose from. | ||
| MovedPermanently = 301 // RFC 7231, 6.4.2 - The resource has been permanently moved to a new URL. | ||
| Found = 302 // RFC 7231, 6.4.3 - The resource is temporarily located at a different URL. | ||
| SeeOther = 303 // RFC 7231, 6.4.4 - The client should retrieve the resource using a different URI. | ||
| NotModified = 304 // RFC 7232, 4.1 - The resource has not been modified since the version specified by the request headers. | ||
| UseProxy = 305 // RFC 7231, 6.4.5 - The requested resource must be accessed through a proxy. | ||
| _ = 306 // RFC 7231, 6.4.6 - (Unused) This status code is no longer in use but reserved. | ||
| TemporaryRedirect = 307 // RFC 7231, 6.4.7 - The resource is temporarily located at a different URI, but future requests should still use the original URI. | ||
| PermanentRedirect = 308 // RFC 7538, 3 - The resource has been permanently moved to a new URI. | ||
|
|
||
| // Client error responses (400–499): These are used to indicate that there was a problem with the request made by the client. | ||
| BadRequest = 400 // RFC 7231, 6.5.1 | ||
| Unauthorized = 401 // RFC 7235, 3.1 | ||
| PaymentRequired = 402 // RFC 7231, 6.5.2 | ||
| Forbidden = 403 // RFC 7231, 6.5.3 | ||
| NotFound = 404 // RFC 7231, 6.5.4 | ||
| MethodNotAllowed = 405 // RFC 7231, 6.5.5 | ||
| NotAcceptable = 406 // RFC 7231, 6.5.6 | ||
| ProxyAuthRequired = 407 // RFC 7235, 3.2 | ||
| RequestTimeout = 408 // RFC 7231, 6.5.7 | ||
| Conflict = 409 // RFC 7231, 6.5.8 | ||
| Gone = 410 // RFC 7231, 6.5.9 | ||
| LengthRequired = 411 // RFC 7231, 6.5.10 | ||
| PreconditionFailed = 412 // RFC 7232, 4.2 | ||
| RequestEntityTooLarge = 413 // RFC 7231, 6.5.11 | ||
| RequestURITooLong = 414 // RFC 7231, 6.5.12 | ||
| UnsupportedMediaType = 415 // RFC 7231, 6.5.13 | ||
| RequestedRangeNotSatisfiable = 416 // RFC 7233, 4.4 | ||
| ExpectationFailed = 417 // RFC 7231, 6.5.14 | ||
| Teapot = 418 // RFC 7168, 2.3.3 | ||
| MisdirectedRequest = 421 // RFC 7540, 9.1.2 | ||
| UnprocessableEntity = 422 // RFC 4918, 11.2 | ||
| Locked = 423 // RFC 4918, 11.3 | ||
| FailedDependency = 424 // RFC 4918, 11.4 | ||
| UpgradeRequired = 426 // RFC 7231, 6.5.15 | ||
| PreconditionRequired = 428 // RFC 6585, 3 | ||
| TooManyRequests = 429 // RFC 6585, 4 | ||
| RequestHeaderFieldsTooLarge = 431 // RFC 6585, 5 | ||
| UnavailableForLegalReasons = 451 // RFC 7725, 3 | ||
| // Client error responses (400–499): These indicate that there was an error in the request sent by the client. | ||
| BadRequest = 400 // RFC 7231, 6.5.1 - The server could not understand the request due to invalid syntax. | ||
| Unauthorized = 401 // RFC 7235, 3.1 - Authentication is required to access the resource. | ||
| PaymentRequired = 402 // RFC 7231, 6.5.2 - Reserved for future use, originally intended for payment. | ||
| Forbidden = 403 // RFC 7231, 6.5.3 - The client does not have permission to access the resource. | ||
| NotFound = 404 // RFC 7231, 6.5.4 - The server could not find the requested resource. | ||
| MethodNotAllowed = 405 // RFC 7231, 6.5.5 - The request method is not supported for the requested resource. | ||
| NotAcceptable = 406 // RFC 7231, 6.5.6 - The requested resource cannot generate content acceptable according to the Accept headers. | ||
| ProxyAuthRequired = 407 // RFC 7235, 3.2 - The client must authenticate with a proxy. | ||
| RequestTimeout = 408 // RFC 7231, 6.5.7 - The client did not send a complete request within the time allowed by the server. | ||
| Conflict = 409 // RFC 7231, 6.5.8 - The request could not be completed due to a conflict with the current state of the resource. | ||
| Gone = 410 // RFC 7231, 6.5.9 - The resource requested is no longer available and will not be available again. | ||
| LengthRequired = 411 // RFC 7231, 6.5.10 - The request did not specify the length of its content, which is required by the server. | ||
| PreconditionFailed = 412 // RFC 7232, 4.2 - One or more preconditions given in the request headers were not met. | ||
| RequestEntityTooLarge = 413 // RFC 7231, 6.5.11 - The request is larger than the server is willing or able to process. | ||
| RequestURITooLong = 414 // RFC 7231, 6.5.12 - The URI requested by the client is longer than the server can handle. | ||
| UnsupportedMediaType = 415 // RFC 7231, 6.5.13 - The media format of the requested data is not supported by the server. | ||
| RequestedRangeNotSatisfiable = 416 // RFC 7233, 4.4 - The range specified by the Range header field cannot be fulfilled. | ||
| ExpectationFailed = 417 // RFC 7231, 6.5.14 - The server cannot meet the expectations in the Expect request header. | ||
| Teapot = 418 // RFC 7168, 2.3.3 - A humorous status code indicating that the server is a teapot and cannot brew coffee. | ||
| MisdirectedRequest = 421 // RFC 7540, 9.1.2 - The request was directed to a server that is not able to produce a response. | ||
| UnprocessableEntity = 422 // RFC 4918, 11.2 - The request is well-formed, but the server is unable to process the contained instructions. | ||
| Locked = 423 // RFC 4918, 11.3 - The resource being accessed is locked. | ||
| FailedDependency = 424 // RFC 4918, 11.4 - The request failed due to the failure of a previous request. | ||
| UpgradeRequired = 426 // RFC 7231, 6.5.15 - The client should switch to a different protocol. | ||
| PreconditionRequired = 428 // RFC 6585, 3 - The server requires that the request be conditional. | ||
| TooManyRequests = 429 // RFC 6585, 4 - The client has sent too many requests in a given amount of time ("rate limiting"). | ||
| RequestHeaderFieldsTooLarge = 431 // RFC 6585, 5 - The server is unwilling to process the request because its header fields are too large. | ||
| UnavailableForLegalReasons = 451 // RFC 7725, 3 - The server is denying access to the resource as a consequence of a legal demand. | ||
|
|
||
| // Server error responses (500–599): These indicate that the server encountered a problem and was unable to complete the request. | ||
| InternalServerError = 500 // RFC 7231, 6.6.1 | ||
| NotImplemented = 501 // RFC 7231, 6.6.2 | ||
| BadGateway = 502 // RFC 7231, 6.6.3 | ||
| ServiceUnavailable = 503 // RFC 7231, 6.6.4 | ||
| GatewayTimeout = 504 // RFC 7231, 6.6.5 | ||
| HTTPVersionNotSupported = 505 // RFC 7231, 6.6.6 | ||
| VariantAlsoNegotiates = 506 // RFC 2295, 8.1 | ||
| InsufficientStorage = 507 // RFC 4918, 11.5 | ||
| LoopDetected = 508 // RFC 5842, 7.2 | ||
| NotExtended = 510 // RFC 2774, 7 | ||
| NetworkAuthenticationRequired = 511 // RFC 6585, 6 | ||
| // Server error responses (500–599): These indicate that the server encountered an error or is unable to perform the request. | ||
| InternalServerError = 500 // RFC 7231, 6.6.1 - The server encountered an unexpected condition that prevented it from fulfilling the request. | ||
| NotImplemented = 501 // RFC 7231, 6.6.2 - The server does not support the functionality required to fulfill the request. | ||
| BadGateway = 502 // RFC 7231, 6.6.3 - The server, while acting as a gateway or proxy, received an invalid response from the upstream server. | ||
| ServiceUnavailable = 503 // RFC 7231, 6.6.4 - The server is currently unable to handle the request due to temporary overloading or maintenance. | ||
| GatewayTimeout = 504 // RFC 7231, 6.6.5 - The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server. | ||
| HTTPVersionNotSupported = 505 // RFC 7231, 6.6.6 - The server does not support the HTTP protocol version used in the request. | ||
| VariantAlsoNegotiates = 506 // RFC 2295, 8.1 - The server has an internal configuration error and cannot complete the request. | ||
| InsufficientStorage = 507 // RFC 4918, 11.5 - The server is unable to store the representation needed to complete the request. | ||
| LoopDetected = 508 // RFC 5842, 7.2 - The server detected an infinite loop while processing the request. | ||
| NotExtended = 510 // RFC 2774, 7 - Further extensions to the request are required for the server to fulfill it. | ||
| NetworkAuthenticationRequired = 511 // RFC 6585, 6 - The client needs to authenticate to gain network access. | ||
| ) |