From 387af5a51f2b097569ad78cd3deaccdc47e15942 Mon Sep 17 00:00:00 2001 From: Ubergeek Date: Wed, 22 Jan 2020 11:22:56 -0500 Subject: [PATCH] Adding new API call --- articles/wiki/api.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/articles/wiki/api.md b/articles/wiki/api.md index 7c43415..6cadac3 100644 --- a/articles/wiki/api.md +++ b/articles/wiki/api.md @@ -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 418 for requests to the "/teapot" endpoint. + 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. @@ -62,3 +64,15 @@ This will return a struct of system uptime: "secs":3 } ``` + +### teapot + +This shall return a struct, describing the current tea making capabilities of the system: + +``` +{ + "tea" : "available", + "height" : "short", + "width" : "stout +} +```