Thunix
/
wiki
mirror of https://github.com/ThunixdotNet/wiki.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Adding new API call

This commit is contained in:
Ubergeek 2020-01-22 11:22:56 -05:00
parent ac0749c01b
commit 387af5a51f
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
articles/wiki/api.md
View File

@ -12,6 +12,8 @@ The API shall return a 401 for unauthenticated requests.
The API shall return a 403 for requests which are authenticated, but not permissible for the authenticated user. The API shall return a 403 for requests which are authenticated, but not permissible for the authenticated user.
The API shall return a 418 for requests to the "/teapot" endpoint.
The API shall return a 420 for requests exceeding the rate limits. The API shall return a 420 for requests exceeding the rate limits.
The API shall return a 501 for requests which exist in the spec, but have not been implmented yet. The API shall return a 501 for requests which exist in the spec, but have not been implmented yet.
@ -62,3 +64,15 @@ This will return a struct of system uptime:
"secs":3 "secs":3
} }
``` ```
### teapot
This shall return a struct, describing the current tea making capabilities of the system:
```
{
"tea" : "available",
"height" : "short",
"width" : "stout
}
```