Add description to server error responses

Author: thejfreitas

src/StatusCode/index.ts

@@ -218,47 +218,47 @@ export enum StatusCode {
    */
   UNAVAILABLE_FOR_LEGAL_REASONS = 451,
   /**
-   * @description - @
+   * @description 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.
    */
   INTERNAL_SERVER_ERROR = 500,
   /**
-   * @description - @
+   * @description 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.
    */
   NOT_IMPLEMENTED = 501,
   /**
-   * @description - @
+   * @description 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.
    */
   BAD_GATEWAY = 502,
   /**
-   * @description - @
+   * @description 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.
    */
   SERVICE_UNAVAILABLE = 503,
   /**
-   * @description - @
+   * @description This error response is given when the server is acting as a gateway and cannot get a response in time.
    */
   GATEWAY_TIMEOUT = 504,
   /**
-   * @description - @
+   * @description The HTTP version used in the request is not supported by the server.
    */
   HTTP_VERSION_NOT_SUPPORTED = 505,
   /**
-   * @description - @
+   * @description 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.
    */
   VARIANT_ALSO_NEGOTIATES = 506,
   /**
-   * @description - @
+   * @description The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request.
    */
   INSUFFICIENT_STORAGE = 507,
   /**
-   * @description - @
+   * @description The server detected an infinite loop while processing the request.
    */
   LOOP_DETECTED = 508,
   /**
-   * @description - @
+   * @description Further extensions to the request are required for the server to fulfill it.
    */
   NOT_EXTENDED = 510,
   /**
-   * @description - @
+   * @description Indicates that the client needs to authenticate to gain network access.
    */
   NETWORK_AUTHENTICATION_REQUIRED = 511,
 }

src/StatusDescription/index.ts

@@ -6,7 +6,7 @@
  */
 export enum StatusDescription {
   /**
-   * @description - StatusCode 100
+   * @description - StatusCode = 100
    */
   CONTINUE = "This interim response indicates that the client should continue the request or ignore the response if the request is already finished.",
   /**
@@ -206,47 +206,47 @@ export enum StatusDescription {
    */
   UNAVAILABLE_FOR_LEGAL_REASONS = "The user agent requested a resource that cannot legally be provided, such as a web page censored by a government.",
   /**
-   * @description - StatusCode 500
+   * @description - StatusCode = 500
    */
   INTERNAL_SERVER_ERROR = "The server has encountered a situation it does not know how to handle.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 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.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 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.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 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 response 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.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 504
    */
   GATEWAY_TIMEOUT = "This error response is given when the server is acting as a gateway and cannot get a response in time.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 505
    */
   HTTP_VERSION_NOT_SUPPORTED = "The HTTP version used in the request is not supported by the server.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 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.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 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.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 508
    */
   LOOP_DETECTED = "The server detected an infinite loop while processing the request.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 510
    */
   NOT_EXTENDED = "Further extensions to the request are required for the server to fulfill it.",
   /**
-   * @description - StatusCode =
+   * @description - StatusCode = 511
    */
   NETWORK_AUTHENTICATION_REQUIRED = "Indicates that the client needs to authenticate to gain network access.",
 }