Add some documentation to the status enum
This commit is contained in:
parent
9f77f255a3
commit
fae2fe3837
1 changed files with 23 additions and 2 deletions
|
|
@ -1,7 +1,28 @@
|
||||||
export enum Status {
|
export enum Status {
|
||||||
|
/** The request was successful */
|
||||||
Success = 200,
|
Success = 200,
|
||||||
UnknownError = 400,
|
|
||||||
|
/**
|
||||||
|
* The request contains malformed data and cannot be processed.
|
||||||
|
*/
|
||||||
|
BadRequest = 400,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Some data is out of date and needs to be updated before another request
|
||||||
|
* can be made. Check the "message" for additional information.
|
||||||
|
*/
|
||||||
OutOfDate = 401,
|
OutOfDate = 401,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Something in the request couldn't be found. Check the "message" for
|
||||||
|
* additional information.
|
||||||
|
*/
|
||||||
NotFound = 404,
|
NotFound = 404,
|
||||||
Teapot = 418,
|
|
||||||
|
/**
|
||||||
|
* Something went wrong in the server that we don't have a more specific
|
||||||
|
* error for. Check the "message" for additional details. This may be
|
||||||
|
* fixable by the client who made the request, it may not be.
|
||||||
|
*/
|
||||||
|
UnknownError = 500,
|
||||||
}
|
}
|
||||||
Loading…
Add table
Add a link
Reference in a new issue