From fcfac30caab18ab53bfb2afa73a41f0411e4794d Mon Sep 17 00:00:00 2001 From: AccioBooks Date: Thu, 3 Nov 2016 08:31:30 -0500 Subject: [PATCH] Api doc status (#8165) * Add example * Update example --- website/server/controllers/api-v3/status.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/website/server/controllers/api-v3/status.js b/website/server/controllers/api-v3/status.js index d127ffb975..baba426ba7 100644 --- a/website/server/controllers/api-v3/status.js +++ b/website/server/controllers/api-v3/status.js @@ -6,6 +6,11 @@ let api = {}; * @apiGroup Status * * @apiSuccess {String} data.status 'up' if everything is ok + * + * @apiSuccessExample {JSON} Server is Up + * { + * 'status': 'up', + * } */ api.getStatus = { method: 'GET',