http-sts/src/models/httpStatusCodes.ts

HTTP status codes

import { HTTPStatusCodeType, HTTPStatusCode } from ".";

export class HTTPStatusCodes {
  static CODE_100: HTTPStatusCodeType = new HTTPStatusCode(
    100,
    "Continue",
    "This interim response indicates that everything so far is OK and that the client should continue the request, or ignore the response if the request is already finished."
  );
  static CODE_101: HTTPStatusCodeType = new HTTPStatusCode(
    101,
    "Switching protocol",
    "This code is sent in response to an Upgrade request header from the client, and indicates the protocol the server is switching to."
  );
  static CODE_102: HTTPStatusCodeType = new HTTPStatusCode(
    102,
    "Processing",
    "This code indicates that the server has received and is processing the request, but no response is available yet."
  );
  static CODE_103: HTTPStatusCodeType = new HTTPStatusCode(
    103,
    "Early hints",
    "This status code is primarily intended to be used with the Link header, letting the user agent start preloading resources while the server prepares a response."
  );
  static CODE_200: HTTPStatusCodeType = new HTTPStatusCode(
    200,
    "OK",
    `The request has succeeded. The meaning of the success depends on the HTTP method:
GET: The resource has been fetched and is transmitted in the message body.
HEAD: The entity headers are in the message body.
PUT or POST: The resource describing the result of the action is transmitted in the message body.
TRACE: The message body contains the request message as received by the server`
  );
  static CODE_201: HTTPStatusCodeType = new HTTPStatusCode(
    201,
    "Created",
    "The request has succeeded and a new resource has been created as a result. This is typically the response sent after POST requests, or some PUT requests."
  );
  static CODE_202: HTTPStatusCodeType = new HTTPStatusCode(
    202,
    "Accepted",
    "The request has been received but not yet acted upon. It is noncommittal, since there is no way in HTTP to later send an asynchronous response indicating the outcome of the request. It is intended for cases where another process or server handles the request, or for batch processing."
  );
  static CODE_203: HTTPStatusCodeType = new HTTPStatusCode(
    203,
    "Non-Authoritative Information",
    `This response code means the returned meta-information is not exactly the same as is available from the origin server, but is collected from a local or a third-party copy. This is mostly used for mirrors or backups of another resource. Except for that specific case, the "200 OK" response is preferred to this status.`
  );
  static CODE_204: HTTPStatusCodeType = new HTTPStatusCode(
    204,
    "No Content",
    "There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones."
  );
  static CODE_205: HTTPStatusCodeType = new HTTPStatusCode(
    205,
    "Reset Content",
    "Tells the user-agent to reset the document which sent this request."
  );
  static CODE_206: HTTPStatusCodeType = new HTTPStatusCode(
    206,
    "Partial Content",
    "This response code is used when the Range header is sent from the client to request only part of a resource."
  );
  static CODE_207: HTTPStatusCodeType = new HTTPStatusCode(
    207,
    "Multi-Status",
    "Conveys information about multiple resources, for situations where multiple status codes might be appropriate."
  );
  static CODE_208: HTTPStatusCodeType = new HTTPStatusCode(
    208,
    "Already Reported",
    "Used inside a <dav:propstat> response element to avoid repeatedly enumerating the internal members of multiple bindings to the same collection."
  );
  static CODE_226: HTTPStatusCodeType = new HTTPStatusCode(
    226,
    "IM Used",
    "The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance."
  );
  static CODE_300: HTTPStatusCodeType = new HTTPStatusCode(
    300,
    "Multiple Choice",
    "The request has more than one possible response. The user-agent or user should choose one of them. (There is no standardized way of choosing one of the responses, but HTML links to the possibilities are recommended so the user can pick.)"
  );
  static CODE_301: HTTPStatusCodeType = new HTTPStatusCode(
    301,
    "Moved Permanently",
    "The URL of the requested resource has been changed permanently. The new URL is given in the response."
  );
  static CODE_302: HTTPStatusCodeType = new HTTPStatusCode(
    302,
    "Found",
    "This response code means that the URI of requested resource has been changed temporarily. Further changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests."
  );
  static CODE_303: HTTPStatusCodeType = new HTTPStatusCode(
    303,
    "See Other",
    "The server sent this response to direct the client to get the requested resource at another URI with a GET request."
  );
  static CODE_304: HTTPStatusCodeType = new HTTPStatusCode(
    304,
    "Not Modified",
    "This is used for caching purposes. It tells the client that the response has not been modified, so the client can continue to use the same cached version of the response."
  );
  static CODE_305: HTTPStatusCodeType = new HTTPStatusCode(
    305,
    "Use Proxy",
    "Defined in a previous version of the HTTP specification to indicate that a requested response must be accessed by a proxy. It has been deprecated due to security concerns regarding in-band configuration of a proxy."
  );
  static CODE_306: HTTPStatusCodeType = new HTTPStatusCode(
    306,
    "unused",
    "This response code is no longer used; it is just reserved. It was used in a previous version of the HTTP/1.1 specification."
  );
  static CODE_307: HTTPStatusCodeType = new HTTPStatusCode(
    307,
    "Temporary Redirect",
    "The server sends this response to direct the client to get the requested resource at another URI with same method that was used in the prior request. This has the same semantics as the 302 Found HTTP response code, with the exception that the user agent must not change the HTTP method used: If a POST was used in the first request, a POST must be used in the second request."
  );
  static CODE_308: HTTPStatusCodeType = new HTTPStatusCode(
    308,
    "Permanent Redirect",
    "This means that the resource is now permanently located at another URI, specified by the Location: HTTP Response header. This has the same semantics as the 301 Moved Permanently HTTP response code, with the exception that the user agent must not change the HTTP method used: If a POST was used in the first request, a POST must be used in the second request."
  );
  static CODE_400: HTTPStatusCodeType = new HTTPStatusCode(
    400,
    "Bad Request",
    "The server could not understand the request due to invalid syntax."
  );
  static CODE_401: HTTPStatusCodeType = new HTTPStatusCode(
    401,
    "Unauthorized",
    `Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.`
  );
  static CODE_402: HTTPStatusCodeType = new HTTPStatusCode(
    402,
    "Payment Required ",
    "This response code is reserved for future use. The initial aim for creating this code was using it for digital payment systems, however this status code is used very rarely and no standard convention exists."
  );
  static CODE_403: HTTPStatusCodeType = new HTTPStatusCode(
    403,
    "Forbidden",
    "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401, the client's identity is known to the server."
  );
  static CODE_404: HTTPStatusCodeType = new HTTPStatusCode(
    404,
    "Not Found",
    "The server can not find the requested resource. In the browser, this means the URL is not recognized. In an API, this can also mean that the endpoint is valid but the resource itself does not exist. Servers may also send this response instead of 403 to hide the existence of a resource from an unauthorized client. This response code is probably the most famous one due to its frequent occurrence on the web."
  );
  static CODE_405: HTTPStatusCodeType = new HTTPStatusCode(
    405,
    "Method Not Allowed",
    "The request method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code."
  );
  static CODE_406: HTTPStatusCodeType = new HTTPStatusCode(
    406,
    "Not Acceptable",
    "This response is sent when the web server, after performing server-driven content negotiation, doesn't find any content that conforms to the criteria given by the user agent."
  );
  static CODE_407: HTTPStatusCodeType = new HTTPStatusCode(
    407,
    "Proxy Authentication Required",
    "This is similar to 401 but authentication is needed to be done by a proxy."
  );
  static CODE_408: HTTPStatusCodeType = new HTTPStatusCode(
    408,
    "Request Timeout",
    "This response is sent on an idle connection by some servers, even without any previous request by the client. It means that the server would like to shut down this unused connection. This response is used much more since some browsers, like Chrome, Firefox 27+, or IE9, use HTTP pre-connection mechanisms to speed up surfing. Also note that some servers merely shut down the connection without sending this message."
  );
  static CODE_409: HTTPStatusCodeType = new HTTPStatusCode(
    409,
    "Conflict",
    "This response is sent when a request conflicts with the current state of the server."
  );
  static CODE_410: HTTPStatusCodeType = new HTTPStatusCode(
    410,
    "Gone",
    `This response is sent when the requested content has been permanently deleted from server, with no forwarding address. Clients are expected to remove their caches and links to the resource. The HTTP specification intends this status code to be used for "limited-time, promotional services". APIs should not feel compelled to indicate resources that have been deleted with this status code.`
  );
  static CODE_411: HTTPStatusCodeType = new HTTPStatusCode(
    411,
    "Length Required",
    "Server rejected the request because the Content-Length header field is not defined and the server requires it."
  );
  static CODE_412: HTTPStatusCodeType = new HTTPStatusCode(
    412,
    "Precondition Failed",
    "The client has indicated preconditions in its headers which the server does not meet."
  );
  static CODE_413: HTTPStatusCodeType = new HTTPStatusCode(
    413,
    "Payload Too Large",
    "Request entity is larger than limits defined by server; the server might close the connection or return an Retry-After header field."
  );
  static CODE_414: HTTPStatusCodeType = new HTTPStatusCode(
    414,
    "URI Too Long",
    "The URI requested by the client is longer than the server is willing to interpret."
  );
  static CODE_415: HTTPStatusCodeType = new HTTPStatusCode(
    415,
    "Unsupported Media Type",
    "The media format of the requested data is not supported by the server, so the server is rejecting the request."
  );
  static CODE_416: HTTPStatusCodeType = new HTTPStatusCode(
    416,
    "Range Not Satisfiable",
    "The range specified by the Range header field in the request can't be fulfilled; it's possible that the range is outside the size of the target URI's data."
  );
  static CODE_417: HTTPStatusCodeType = new HTTPStatusCode(
    417,
    "Expectation Failed",
    "This response code means the expectation indicated by the Expect request header field can't be met by the server."
  );
  static CODE_418: HTTPStatusCodeType = new HTTPStatusCode(
    418,
    "I'm a teapot",
    "The server refuses the attempt to brew coffee with a teapot."
  );
  static CODE_421: HTTPStatusCodeType = new HTTPStatusCode(
    421,
    "Misdirected Request",
    "The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI."
  );
  static CODE_422: HTTPStatusCodeType = new HTTPStatusCode(
    422,
    "Unprocessable Entity",
    "The request was well-formed but was unable to be followed due to semantic errors."
  );
  static CODE_423: HTTPStatusCodeType = new HTTPStatusCode(
    423,
    "Locked",
    "The resource that is being accessed is locked."
  );
  static CODE_424: HTTPStatusCodeType = new HTTPStatusCode(
    424,
    "Failed Dependency",
    "The request failed due to failure of a previous request."
  );
  static CODE_425: HTTPStatusCodeType = new HTTPStatusCode(
    425,
    "Too Early",
    "Indicates that the server is unwilling to risk processing a request that might be replayed."
  );
  static CODE_426: HTTPStatusCodeType = new HTTPStatusCode(
    426,
    "Upgrade Required",
    "The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. The server sends an Upgrade header in a 426 response to indicate the required protocol(s)."
  );
  static CODE_428: HTTPStatusCodeType = new HTTPStatusCode(
    428,
    "Precondition Required",
    "The origin server requires the request to be conditional. This response is intended to prevent the 'lost update' problem, where a client GETs a resource's state, modifies it, and PUTs it back to the server, when meanwhile a third party has modified the state on the server, leading to a conflict."
  );
  static CODE_429: HTTPStatusCodeType = new HTTPStatusCode(
    429,
    "Too Many Requests",
    `The user has sent too many requests in a given amount of time ("rate limiting").`
  );
  static CODE_431: HTTPStatusCodeType = new HTTPStatusCode(
    431,
    "Request Header Fields Too Large",
    "The server is unwilling to process the request because its header fields are too large. The request may be resubmitted after reducing the size of the request header fields."
  );
  static CODE_451: HTTPStatusCodeType = new HTTPStatusCode(
    451,
    "Unavailable For Legal Reasons",
    "The user-agent requested a resource that cannot legally be provided, such as a web page censored by a government."
  );
  static CODE_500: HTTPStatusCodeType = new HTTPStatusCode(
    500,
    "Internal Server Error",
    "The server has encountered a situation it doesn't know how to handle."
  );
  static CODE_501: HTTPStatusCodeType = new HTTPStatusCode(
    501,
    "Not Implemented",
    "The request method is not supported by the server and cannot be handled. The only methods that servers are required to support (and therefore that must not return this code) are GET and HEAD."
  );
  static CODE_502: HTTPStatusCodeType = new HTTPStatusCode(
    502,
    "Bad Gateway",
    "This error response means that the server, while working as a gateway to get a response needed to handle the request, got an invalid response."
  );
  static CODE_503: HTTPStatusCodeType = new HTTPStatusCode(
    503,
    "Service Unavailable",
    "The server is not ready to handle the request. Common causes are a server that is down for maintenance or that is overloaded. Note that together with this response, a user-friendly page explaining the problem should be sent. This responses should be used for temporary conditions and the Retry-After: HTTP header should, if possible, contain the estimated time before the recovery of the service. The webmaster must also take care about the caching-related headers that are sent along with this response, as these temporary condition responses should usually not be cached."
  );
  static CODE_504: HTTPStatusCodeType = new HTTPStatusCode(
    504,
    "Gateway Timeout",
    "This error response is given when the server is acting as a gateway and cannot get a response in time."
  );
  static CODE_505: HTTPStatusCodeType = new HTTPStatusCode(
    505,
    "HTTP Version Not Supported",
    "The HTTP version used in the request is not supported by the server."
  );
  static CODE_506: HTTPStatusCodeType = new HTTPStatusCode(
    506,
    "Variant Also Negotiates",
    "The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process."
  );
  static CODE_507: HTTPStatusCodeType = new HTTPStatusCode(
    507,
    "Insufficient Storage",
    "The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request."
  );
  static CODE_508: HTTPStatusCodeType = new HTTPStatusCode(
    508,
    "Loop Detected",
    "The server detected an infinite loop while processing the request."
  );
  static CODE_510: HTTPStatusCodeType = new HTTPStatusCode(
    510,
    "Not Extended",
    "Further extensions to the request are required for the server to fulfil it."
  );
  static CODE_511: HTTPStatusCodeType = new HTTPStatusCode(
    511,
    "Network Authentication Required",
    "The 511 status code indicates that the client needs to authenticate to gain network access."
  );
}